使用JSONAPI模式的RESTful相关资源

时间:2016-06-10 16:38:44

标签: rest json-api

我正在关注jsonapi架构以返回来自Web API的标准化响应。我想减少获取相关信息的HTTP请求数,因此看起来我想使用compound documents返回(例如)一篇文章和两条相关的评论。

我有点理解这一点,但我想知道RESTful GET请求会是什么?我在想像

这样的东西
http://api.mysite.com/v1/articles/1?comments=2

我喜欢明确但是为了从资源返回相关信息所需的请求参数?

1 个答案:

答案 0 :(得分:1)

听起来像你想要/ v1 / articles / 1?include = comments& limitComments = 2

其中limitComments是API特定的参数(注意成员名称要求)

this section http://jsonapi.org/format/#query-parameters

或者,你可以/ v1 / comments?include = articles& filter [articles] = 1& page [size] = 2

参见http://jsonapi.org/format/#fetching-includeshttp://jsonapi.org/recommendations/#filtering