针对请求元数据（会话ID等）的RESTful API设计最佳实践？

Question

在设计REST API时，传递统计信息和日志记录所需的元数据的最佳实践是什么，但是哪种方法不会改变服务器的响应？

例如，如果我有找最近的公共厕所的服务，我可能想知道用户的位置是否由GPS确定。 或者，如果最终用户的请求通过多个系统，我可能希望传递请求ID进行调试。

据我了解，选项为：

查询参数

• 就像Google Maps API上的'sensor'参数一样。
• 正确，因为它允许用户使用常规的网络浏览器浏览API。
• 正确，因为对于难以发送自定义HTTP标头的客户端而言，它更简单。
• 错误的原因是过滤器参数仅用于过滤，排序和搜索。
• 错误的是，如果资源没有更改，为什么还要输入URL？

HTTP标头

• 就像经常进行身份验证
• 正确，因为这是请求元数据的正常位置，不会改变服务器的响应
• 正确，因为对于POST / PUT请求，它避免同时拥有查询参数和请求正文。
• 错误的原因是在使用Web浏览器浏览API时无法设置标头。
• 这是错误的，因为应该避免复杂性，并且URL + Header是比仅URL更复杂的API。

如果允许不存在元数据，哪个是正确的选择？

如果元数据必须存在，答案是否有所不同，尽管元数据的值否则不会改变服务器的响应？

Answer 1

HTTP标头是正确的答案。 那就是他们的目的。

考虑到还有许多其他可行的选项可用于测试Web api，因此将Web浏览器用作调试器并不是特别有效。 诸如Postman，Dev HttpClient，Fiddler，Runscope之类的东西都是测试API的不错方法。