microsoft / microsoft/OpenAPI.NET
Add Builder to simplify openapi document object construction
オープン
まだ誰も着手していません。
help wanted
type:enhancement
- 主要言語
- C#
- スター
- 1.6k
- フォーク
- 286
- 平均マージ
- 6時間 38分
- マージ済み PR(30日)
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
この issue では、ファイル、テスト、エントリポイントが指定されていません。まず既存の OpenAPI ドキュメントオブジェクトモデルと現在の構築パターンを確認し、その後、実装前に builder がサポートする操作、スキーマ、サーバーを明確にしてください。Build() を通じて同等の OpenAPI ドキュメントを構築できる、合意済みの builder API ができれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- csharp, openapi
- 領域
- api, backend-api-design
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100