如何为超媒体/ restful json数组端点

时间:2016-01-07 12:17:11

标签: json rest http jsonschema hateoas

我有一个超媒体/ restful服务,将集合公开为(可页面)端点。这些被序列化为json数组。

我有一个(n自动生成的)每个端点的json模式,并希望将这些模式的位置传达给客户端,但由于端点是json数组,我不能包含' $ schema'包含指向相应模式的链接的属性。

我可以想到几个选项:

  1. 将数组包装在一个json对象中,该对象包含json数组以及schema链接(以及特定于该集合的任何其他属性)

  2. 将架构链接提供为自定义http标头参数

  3. 假设客户只是知道'如何获取端点的架构,而无需明确告知

  4. 向客户端提供根级别的架构URL的一般格式,然后客户端会记住并使用该格式生成所有架构链接本身

  5. 向客户端提供json架构链接的最佳方法是什么?

1 个答案:

答案 0 :(得分:3)

json schema core spec建议使用" Content-Type"或"链接"标题,所以我现在要继续使用它。