Response-Modells für das spezifische status codes mit Swagger

Ich bin mit Swagger zu dokumentieren, meine REST-API (mit asp.net web-api-2). Gibt es eine Möglichkeit in Fors zu geben-response-Modelle für jeden möglichen Antworten an, die für einen bestimmten api-Aufruf? Ich bin Anmerkungen zu den status-code der Antwort unter Verwendung der xml-Kommentare in etwa so:

    ///<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() {...}

Response-Modells für das spezifische status codes mit Swagger

InformationsquelleAutor Kaladin | 2015-04-07
  1. 28

    Können Sie versuchen, mit cref="GEBEN Sie HIER" Ihre XML-Kommentare wie diese.

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

    B
    ut ich würde vorschlagen, mit Anmerkungen, Swagger gibt Sie.

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

    Attribut Sie Ihren Controller mit diesem.

    • es wäre gut, wenn du teilen kannst, von wo du diese Dokumentation?
    InformationsquelleAutor EvilToaster101
  2. 8

    Deine Signatur sagt, du bist der Rückkehr eine HttpResponseMessage, nicht ein Daten-Modell. Wenn Sie die Rückgabe eines IActionResult, können Sie die "ProducesResponseType" - Attribut.

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

    ProducesResponsesType ist in Microsoft.AspNetCore.Mvc-namespace.

    Sehen
    https://github.com/domaindrivendev/Swashbuckle.AspNetCore#list-operation-responses
    "Explizite Antworten"

    • Das ist nur gültig im Kern.
    InformationsquelleAutor Elton
  3. 1

    Können Sie versuchen,

     [SwaggerResponse(200, typeof(CustomModel))]

    ist und Sie zusätzlich einen Kommentar hinzufügen für, die Antwort geben Sie als optionalen Dritten parameter

    [SwaggerResponse(200, typeof(CustomModel), "returns a new id of the bla bla")]
    InformationsquelleAutor L. Mihai
Schreibe einen Kommentar