Comment créer un objet incorporé dans Swagger YAML?

Question

Je veux ajouter une ressource HAL liant à une définition,

definitions 
    HalItemResponse: 
    name: 
     type: string 

Que ajouter

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

Comment?

Answer 1

Où que vous vouliez utiliser la définition, généralement dans une requête ou une réponse, vous la référenceriez comme cela.

JSON

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

YAML

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

Très similaire à celle du type, mais plutôt pointant vers le schéma de définition.