RicoSuter/NSwag

typeof(void) still produces a response type of ProblemDetails

Open

#2.861 geöffnet am 30. Mai 2020

Auf GitHub ansehen
 (6 Kommentare) (9 Reaktionen) (0 zugewiesene Personen)C# (1.189 Forks)batch import
help wantedproject: NSwag.SwaggerGeneration.AspNetCore

Repository-Metriken

Stars
 (6.291 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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"
                }
              }
            }
          }

Contributor Guide

Research-Richtung
Untersuche, wie NSwag Antworttypen für void in ProducesResponseTypeAttribute auflöst. Sieh dir SwaggerResponseAttribute oder den Operation Processor an, der Antwort Schemata generiert. Überprüfe die Issue Kommentare auf vorgeschlagene Fixes oder Workarounds. Überlege, ob der Fix die Änderung der Antwort Schemagenerierung beinhaltet, um Schemata für void Typen zu überspringen.
Tech Stack
csharp
Domain
backendapi
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#ASP.NET CoreNSwag basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45