RicoSuter/NSwag

Generating C# Web API Controllers, no response codes

Open

#1.918 geöffnet am 24. Jan. 2019

Auf GitHub ansehen
 (1 Kommentar) (4 Reaktionen) (0 zugewiesene Personen)C# (1.189 Forks)batch import
help wantedproject: NSwag.CodeGeneration.CSharp (Controllers)type: question

Repository-Metriken

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

Beschreibung

From an Open API spec I generate C# code for some web API controllers (ASP.NET Core). However, in the generated code it seems to me that no HTTP status codes are specified (e.g. by using attributes like [ProducesResponseType(404)] before each method definition). This has the effect that the Swagger UI generated from the code lacks any information about the different return codes, only 200 appears. Did I miss anything in the configuration of the code generator?

Contributor Guide

Research-Richtung
Untersuche die NSwag Codegenerierungsvorlagen für C# Controller, insbesondere wie Antworttypen aus OpenAPI Operation Antworten abgebildet werden. Suche nach fehlenden [ProducesResponseType] Attributen im generierten Code. Stelle fest, ob das Problem durch eine Konfigurationsoption wie 'AddResponseCodes' oder durch Ändern der Vorlage, um alle dokumentierten HTTP Statuscodes einzubeziehen, gelöst werden kann. Das Ziel ist sicherzustellen, dass die generierten Controller vollständige Swagger Metadaten bereitstellen.
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.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#ASP.NET Core
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50