如何在Swagger YAML中创建嵌入对象？

Question

我想添加一个链接到定义的HAL资源，

definitions
  HalItemResponse:
    name:
      type: string

添加什么

"_links": {
"self": string,
"filter": string
}

如何？

Answer 1

您想要使用该定义，通常在请求或响应中，您可以像这样引用它。

JSON

{
    halitem: { $ref: '#/defintions/HalItemResponse' }
}

YAML

halitem:
    $ref: '#/definitions/HalItemResponse'

非常类似于设置类型，而是指向定义架构。