RicoSuter/NSwag

Route constraint shown as "string" in UI

Open

#745 opened on 2017年4月28日

GitHub で見る
 (5 comments) (1 reaction) (0 assignees)C# (6,291 stars) (1,189 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.