json - REST API 最佳实践 : args in query string vs in request body

Question

一个 REST API 可以在几个地方有参数:

1. 在请求正文中 - 作为 json 正文或其他 MIME 类型的一部分
2. 在query string - 例如/api/resource?p1=v1&p2=v2
3. 作为 URL 路径的一部分 - 例如/api/resource/v1/v2

在上述 1 和 2 之间进行选择的最佳做法和注意事项是什么？
涵盖了 2 对 3 here .

Answer 1

What are the best practices and considerations of choosing between 1 and 2 above?

通常，内容正文用于上传/下载到服务器/从服务器下载的数据，查询参数用于指定请求的确切数据。例如，当您上传文件时，您在正文中指定名称、mime 类型等，但是当您获取文件列表时，您可以使用查询参数通过文件的某些属性过滤列表。一般来说，查询参数是查询的属性而不是数据。

当然，这不是一个严格的规则——你可以用任何你认为更合适/更适合你的方式来实现它。

您可能还想查看 wikipedia article about query string ，尤其是前两段。