如何设计一个在请求中获取数据并从服务器返回数据的API

Question

我正在设计一个 API /imageMetadataRetrieve，它接受一些输入数据并返回数据作为响应。示例输入数据如下

{
  "imageSource": "google.com/image.png",
  "imageType": "LANDSCAPE",
  "imageResolution": "1920x1080",
  "ImageText": "Google Image",
  "ImageCreated": 12345,
  "ImageLocation": "US"
}

响应将如下所示

{
  "elements": [
    {
      "imageId": 123,
      "imageUrl": "example.com/image.png",
      "metaDataText": "Google Image is taken at the US on April 02, 2023",
      "locale": "en_US"
    },
    {
      "imageId": 123,
      "imageUrl": "example.com/image.png",
      "metaDataText": "Google Image is taken at the US on April 02, 2023",
      "locale": "en_GB"
    }
  ]
}

API 还应该支持简单的 GET。

/imageMetadataRetrieve?imageId=123

应该返回与上面相同的响应。

对于第一种情况使用 POST，对于第二种情况使用 GET 以及 POST 和 GET 的相同响应主体，这是推荐的方法吗？

Answer 1

如果你想使用这样的请求体，那么你需要使用 POST。如果您的 API 实际上不在数据库或任何存储中插入或更新任何数据，它只是在响应模型中进行数据表示（从数据库获取），那么您应该使用 GET 方法。