RicoSuter/NSwag

Route constraint shown as "string" in UI

Open

#745 opened on Apr 28, 2017

View on GitHub
 (5 comments) (1 reaction) (0 assignees)C# (1,189 forks)batch import
help wantedproject: NSwag.SwaggerGeneration.WebApitype: bug

Repository metrics

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

Description

Hi, the documentation says the WebApiToSwaggerGenerator supports "RouteAttribute and ActionNameAttribute on the action method, with support for Route constraints (e.g. [Route("users/{id:int}"])".

Given the following controller action as an example:

[Route("test/{modelToUpdate:guid}")]
public IHttpActionResult UpdateTest([FromUri] TestModel modelToUpdate) {

The swagger UI shows the parameter data type for modelToUpdate as "string". Could reproduce the same if used :int as constraint. The UI always says "string".

Am I missing a special swagger attribute or something?

Thank, bergziege

Contributor guide

Research direction
Investigate how NSwag's WebApiToSwaggerGenerator maps route constraints to OpenAPI parameter types. Look at the handling of constraints like :int, :guid in the route parsing code. Trace the mapping from route template to parameter type to identify where the type is defaulting to string.
Tech stack
csharp
Domain
api
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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
ASP.NET Web API routingSwagger/OpenAPI basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60