请求元数据( session ID 等)的 RESTful API 设计最佳实践？

Question

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

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

据我了解，选项是:

查询参数

就像 Google Maps API 上的“传感器”参数一样。

正确，因为它允许用户使用常规 Web 浏览器探索 API。

正确，因为对于难以发送自定义 HTTP header 的客户来说，它更简单。

错误，因为过滤器参数仅用于过滤、排序和搜索。

错了，因为如果资源没有改变，为什么 URL 应该改变？

HTTP header

像认证一样经常做

正确，因为它是请求元数据的正常位置，不会改变服务器的响应

正确，因为对于 POST/PUT 请求，它避免了同时具有查询参数和请求正文。

错误，因为当您使用 Web 浏览器探索 API 时无法设置 header 。

错误，因为应该避免复杂性，并且 URL+Header 是一个比单独的 URL 更复杂的 API。

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

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

Answer 1

HTTP header 是正确的答案。这就是他们的目的。

考虑到有多少其他可行的选项可用于测试 Web API，Web 浏览器作为调试器并不是特别有效。像 Postman、Dev HttpClient、Fiddler、Runscope 这样的东西都是测试 API 的好方法。