RicoSuter/NSwag

Generating C# Web API Controllers, no response codes

Open

#1,918 opened on Jan 24, 2019

View on GitHub
 (1 comment) (4 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedproject: NSwag.CodeGeneration.CSharp (Controllers)type: question

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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 direction
Check NSwag documentation and code generation settings for including ProducesResponseType attributes; inspect the OpenAPI spec to ensure response codes are defined.
Tech stack
csharp
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#ASP.NET Core
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50