RicoSuter/NSwag

Route constraint shown as "string" in UI

Open

#745 创建于 2017年4月28日

在 GitHub 查看
 (5 评论) (1 反应) (0 负责人)C# (6,291 star) (1,189 fork)batch import
help wantedproject: NSwag.SwaggerGeneration.WebApitype: bug

描述

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

贡献者指南

技术栈
csharp
领域
api
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
C#ASP.NET Web APINSwag basicsSwagger/OpenAPI
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
The issue is that route constraints like :int or :guid are not being mapped to the correct Swagger data types in the generated OpenAPI spec. The root cause likely lies in the WebApiToSwaggerGenerator class in the NSwag repo, specifically how it parses route templates and assigns parameter types. To fix, one would need to add logic to recognize common route constraint tokens (e.g., 'int', 'guid', 'string') and set the corresponding Swagger type (e.g., 'integer', 'string'). Existing unit tests for route parameter handling should be examined to ensure correctness. Additionally, check comments and linked PRs for any prior attempts.