http - RESTfully 请求表示的子部分具有特定的内容类型

Question

我请求(通过 Accept: application/json)我正在设计的 API 响应为 JSON。但是，我希望根据客户端的功能指定该 JSON 中的值符合 text/plain 或 text/html。

“子类型”的 RESTful 最佳实践是什么？如果我正式切换到 HAL 作为顶级容器，这将如何工作？

接受:application/json+text/plain

{
  "value": "Hello World"
}

接受:application/json+text/html

{
  "value": "<h2>Hello World</h2>"
}

Answer 1

您是否考虑过在 Accept: header 中使用参数？例如，请参阅如何为 JSON-LD http://json-ld.org/spec/latest/json-ld-syntax/#application-ld-json 定义配置文件参数.因此，例如您的接受 header 将是应用程序/json； profile="http://mysite.org/json-type/html"

另请记住，RFC 1341 中定义的 X- 字段已弃用:https://www.rfc-editor.org/rfc/rfc6648