OAS 3为数组指定JSON响应的链接

时间:2018-06-07 07:59:53

标签: hateoas openapi

我正在使用Open API 3(OAS 3)创建API规范。我希望我的API的响应有效负载如下所示。

主要是"内容中的每个对象"有一个与之关联的链接。我无法找到使用OAS 3在数组元素内表达链接的示例。

{
"content": [ {
    "name": "iPad",
    "links": [ {
        "rel": "self",
        "href": "http://localhost:8080/product/1"
    } ],

}, {
    "name": "Dock",
    "links": [ {
        "rel": "self",
        "href": "http://localhost:8080/product/3"
    } ],
} ],
}   

教程here建议仅在响应级别指定链接,这意味着我无法为数组中的每个元素表达链接。什么是OAS 3实现等效功能的方法?

responses:
    '200':
      description: Created
      content:
        ...
      links:   # <----
        ...
    '400':
      description: Bad request
      content:
        ...
      links:   # <----
        ...

0 个答案:

没有答案