http - RESTfully 请求表示的子部分是某种内容类型

Question

我请求（通过Accept: application/json）我正在设计的 API 以 JSON 响应。但是，我希望将该 JSON 中的值指定为符合text/plain或text/html取决于客户端的功能。

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

接受：application/json+text/plain

{
  "value": "Hello World"
}

接受：应用程序/json+text/html

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

Answer 1

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

另请记住，不推荐使用 RFC 1341 中定义的 X 字段：https ://www.rfc-editor.org/rfc/rfc6648