microsoft / microsoft/OpenAPI.NET.OData
Expose a middleware to output Open API description for a certain OData service
オープン
まだ誰も着手していません。
status:needs-discussion
type:enhancement
- 主要言語
- C#
- スター
- 240
- フォーク
- 70
- 平均マージ
- 7時間 59分
- マージ済み PR(30日)
- 13
説明
Maybe we can have an extension middleware to expose the OpenAPI description for a certain OData service.
For example:
public class ODataOpenApiMiddleware
{
private readonly RequestDelegate next;
public ODataOpenApiMiddleware(RequestDelegate next)
{
this.next = next;
}
public async Task Invoke(HttpContext context)
{
// implementation here
}
}
Extension method:
public static IApplicationBuilder UseODataOpenApi(this IApplicationBuilder app)
{
return app.UseMiddleware<ODataOpenApiMiddleware>();
}
Configure the Middleware:
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseODataOpenApi();
app.UseRouting();
app.UseEndpoints(...);
}
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
この issue で提案されている ODataOpenApiMiddleware、その Invoke メソッド、UseODataOpenApi 拡張機能、および Configure の例から始めてください。ミドルウェアが特定の OData サービスをどのように選択すべきか、またどのようなレスポンスとルーティングの動作が完了の条件となるかを明確にしてください。実装ファイルやテストは特定されていません。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- csharp, openapi
- 領域
- api, backend
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100