Remplacer Verb niveau Modèle/modèle de schéma dans Swagger-UI

Question

Je travaille avec fanfaronnades-ui pour tenter de normaliser la documentation de l'API. Je compris que pour les verbes (GET, PUT, POST, etc.) qui utilisent un paramètre de corps et doivent donc montrer un modèle et le schéma modèle, le schéma est défini au niveau des ressources (/ animal/ou de magasin dans le magasin pour animaux de compagnie Exemple). Cependant, au sein de notre API, les paramètres du corps nécessaires vont passer du verbe verbe, et il serait agréable d'avoir un modèle pour chacun, qui reflète exactement cela.

La version actuelle de la définition du modèle http://petstore.swagger.wordnik.com/api/api-docs/pet, où la définition du modèle est comme ceci:

swagger-ui-model-def http://i58.tinypic.com/15phegg.png

Est-il possible de passer outre le modèle de niveau de ressources par défaut au niveau du verbe?

Answer 1

Dans la spécification, chacune des ressources a sous-sections pour les méthodes HTTP 2.0 (fanfaronnades obtenir, après, supprimer, etc.). Chacun d'entre eux possède à son tour une balise de paramètres qui correspond à une liste d'objets JSON du formulaire ci-dessous. Pour que le corps à utiliser un schéma séparé, il peut juste être surchargée à l'aide d'une balise de schéma et un sous-étiquette $ref, puis faisant référence à une définition que vous avez fourni séparément dans les définitions sous-section au bas.

{ 
    name: "body", 
    in: "body", 
    description: "set the properties of a pet", 
    schema: { 
     $ref: "#/definitions/PetPut" 
    }, 
    required: true 
}