microsoft / microsoft/OpenAPI.NET
Add Builder to simplify openapi document object construction
未關閉
還沒有人認領這個 Issue。
help wanted
type:enhancement
- 主要語言
- C#
- 星號
- 1.6k
- 分支
- 286
- 平均合併
- 6 小時 38 分鐘
- 30 天內合併 PR
- 35
描述
A regular C# builder pattern would help a lot in many scenarios.
Building an object now is very complex...
Builder pattern is also the "de facto" in Aspnetcore.. so would make sense to expose a similar api
var openApiDocumentBuilder = new OpenApiDocumentBuilder()
.WithServers(...)
.WithOperation(...)
.WithOperation(...)
.WithSchema(...);
//... etc
var openApiDocument = openApiDocumentBuilder.Build();
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
此 issue 未指定任何檔案、測試或進入點。先檢視現有的 OpenAPI 文件物件模型與目前的建構模式,然後在實作之前釐清 builder 支援的操作、schemas 與 servers。完成的標準是:達成共識的 builder API 能透過 Build() 建構出等效的 OpenAPI 文件。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- csharp, openapi
- 領域
- api, backend-api-design
- Issue 類型
- 功能
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 停滯
- 描述清晰度
- 需要釐清
- 新手友好度
- 25/100