如何在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' 

非常相似，設置類型，而是指向定義架構。