Le modèle de réponse pour le statut spécifique des codes à l'aide Swagger

Je suis en utilisant Swagger document mon RESTE de l'API (à l'aide de asp.net web api 2). Est-il possible de swagger pour donner des modèles d'intervention pour chacune des réponses possibles pour un appel d'api? Je suis annoter le code d'état de réponse à l'aide de xml commentaires comme:

    ///<summary>
    ///Save a person
    ///</summary>
    ///<response code="200">Ok</response>
    ///<response code="400">Bad Request</response>
    ///<response code="500">Internal Server error</response>
    public HttpResponseMessage SavePerson() {...}

Le modèle de réponse pour le statut spécifique des codes à l'aide Swagger

Vous pouvez suivre ce - github.com/domaindrivendev/Swashbuckle/issues/254.

OriginalL'auteur Kaladin | 2015-04-07

  1. 21

    Vous pouvez essayer d'utiliser le cref="TYPE" sur votre XML commentaires de ce genre.

    ///<response code="400" cref="CustomErrorModel">Bad Request</response>

    B
    ut, je voudrais suggérer à l'aide d'annotations que Swagger vous donne.

    [SwaggerResponse(HttpStatusCode.OK, Type = typeof(OnlineMerchantQueryResponseInformation))]

    attribut vos Contrôleurs.

    il serait bon si vous pouvez partager à partir d'où vous avez trouvé cette documentation?

    OriginalL'auteur EvilToaster101

  2. 4

    Votre signature indique que vous êtes de retour d'une HttpResponseMessage, pas un modèle de données. Si vous êtes de retour d'une IActionResult, vous pouvez utiliser le bouton "ProducesResponseType" attribut.

    [ProducesResponseType(typeof(IEnumerable<YourModel>), 200)]

    ProducesResponsesType est en Microsoft.AspNetCore.Mvc espace de noms.

    Voir
    https://github.com/domaindrivendev/Swashbuckle.AspNetCore#list-operation-responses
    "Des Réponses Explicites"

    C'est seulement valide dans la Base.

    OriginalL'auteur Elton

  3. 1

    Vous pouvez essayer

     [SwaggerResponse(200, typeof(CustomModel))]

    et vous en outre ajouter un commentaire pour ce type de réponse en tant que troisième paramètre facultatif

    [SwaggerResponse(200, typeof(CustomModel), "returns a new id of the bla bla")]

    OriginalL'auteur L. Mihai