RicoSuter/NSwag

Generating C# Web API Controllers, no response codes

Open

#1,918 建立於 2019年1月24日

在 GitHub 查看
 (1 留言) (4 反應) (0 負責人)C# (1,189 fork)batch import
help wantedproject: NSwag.CodeGeneration.CSharp (Controllers)type: question

倉庫指標

Star
 (6,291 star)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

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?

貢獻者指南

研究方向
研究 NSwag 的 C# 控制器程式碼生成範本，特別是 OpenAPI 操作回應如何對應為回應類型。查找生成程式碼中缺失的 [ProducesResponseType] 屬性。確定問題是否可以透過配置選項（如 'AddResponseCodes'）或修改範本以包含所有已記錄的 HTTP 狀態碼來解決。目標是確保生成的控制器提供完整的 Swagger 元資料。
技術棧
csharp
領域
backendapi
議題類型
錯誤
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
C#ASP.NET Core
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50