发送有关资源的额外信息的 JSON:API 标准是什么?

Question

我有一个端点，它响应要在可排序表中填充的数据。但是有些列不是可排序的列，我想使用JSON：API规范在我的响应中传达这些列。

我没有找到太多关于这些细节的信息。

那么，与 API 使用者交流此类数据的最佳方式是什么？

我倾向于的一种观点是将它们放在元数据中 田！

非常感谢

Answer 1

JSON：API 允许您使用元对象提供非标准的元信息。元信息可以是针对完整文档、每个资源或每个资源关系的信息。支持排序的字段的信息是完整文档的元信息。

该规范未涵盖如何格式化此类元信息。我也不知道有任何涵盖您的用例的建议或配置文件。因此，您应该提出特定于API的实现。例如，您可以提供一个字段数组，可用于在元对象的键下排序sortable这些字段。如果支持按关系的字段排序，则可以使用点分隔路径。这将与included查询参数的值内联。

示例可能如下所示：

{
"data": [
{ 
"type": "posts",
"id": "1",
"attributes": {
"title": "An example post",
"createdAt": "2019-08-05T11:11:11.000Z",
"body": "..."
},
"relationships": {
"author": {
// ...
},
}
},
// ...
},
"meta": {
"sortable": [
"author.name",
"createdAt",
"title"
]
}
}

请注意，我说的是字段。JSON：API 规范没有在您的问题中使用的术语列，但我很确定您的意思是规范定义的字段：

资源对象的属性及其关系统称为其"字段"。