RicoSuter/NSwag

Add support for explicit inclusion of binding attributes in C# Controller generation

Open

#1,440 opened on Jul 5, 2018

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

Repository metrics

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

Description

My swagger file uses query parameters for string list types, but the generated code does not include the necessary [FromUri] attribute to ensure query parameter bindings are used. Instead, the default WebAPI rules for parameter binding assume content/body bindings. This forces me to add this attributes in my deriving classes which is redundant considering I already specified a query parameter binding in my swagger file.

Contributor guide

Research direction
Examine NSwag's code generation logic for C# controllers, focusing on how query parameters are translated to binding attributes. Look for the absence of [FromUri] when the Swagger spec specifies query parameter locations. Consider reviewing the relevant source files in the NSwag repository, such as the C# controller template or code generator, to understand where the attribute assignment occurs.
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.
Half day
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 Web APISwagger/OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70