RicoSuter/NSwag

typeof(void) still produces a response type of ProblemDetails

Open

#2861 aperta il 30 mag 2020

Vedi su GitHub
 (6 commenti) (9 reazioni) (0 assegnatari)C# (1189 fork)batch import
help wantedproject: NSwag.SwaggerGeneration.AspNetCore

Metriche repository

Star
 (6291 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

According to wiki "To define an operation without a response (i.e. HTTP 204 or 404), use the SwaggerResponseAttribute attribute and typeof(void)". Also according to wiki "SwaggerResponseAttribute(httpAction, type) (not recommended/deprecated, use ASP.NET Core's ProducesResponseTypeAttribute instead)".

So, I use this:

[ProducesResponseType(typeof(void), 404)]

Expected: 404 should have no response body.

Actual:

"404": {
            "description": "Blah blah.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }

Guida contributor

Direzione di ricerca
Indaga come NSwag risolve i tipi di risposta per void in ProducesResponseTypeAttribute. Esamina SwaggerResponseAttribute o il processore di operazioni che genera gli schemi di risposta. Controlla i commenti dell'issue per eventuali correzioni proposte o soluzioni alternative. Considera se la correzione comporta la modifica della generazione dello schema di risposta per saltare lo schema per i tipi void.
Tech stack
csharp
Dominio
backendapi
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C#ASP.NET CoreNSwag basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45