タグ: openapi

ASP.NET Core 11 で UseSwaggerUI を MapScalarApiReference に置き換えます。ルーティング、複数ドキュメント、認証情報の事前入力、本番環境での制御、CDN 不要のアセット、そして Scalar 固有の OpenAPI 拡張を解説します。

Swashbuckle の IOperationFilter と ISchemaFilter のコードを .NET 11 の組み込みのオペレーショントランスフォーマーとスキーマトランスフォーマーへ移すための、フィルターごとの移行リファレンスです。コンテキストオブジェクトのマッピングと、コンパイルを壊す Microsoft.OpenApi v2 の変更を扱います。

ハンドラーの戻り値の型を Results<Ok<T>, NotFound> と宣言し、TypedResults.Ok / TypedResults.NotFound を返します。ユニオンはハンドラーが宣言したものだけを返すことをコンパイル時にチェックし、OpenAPI に対して自己記述するため、.Produces を手書きする必要がありません。非同期ハンドラー、6 型の上限、ASP.NET Core 11 でのテストを扱います。

.NET 11 に組み込まれた OpenAPI トランスフォーマーパイプラインの詳細解説：operation トランスフォーマーと schema トランスフォーマーの違い、コンテキストオブジェクト、実行順序、DI で活性化されるトランスフォーマー、そしてヘッダー・レスポンス・サンプル・プロパティ単位の調整のためのレシピ。

.NET 11 で Swashbuckle.AspNetCore から Microsoft.AspNetCore.OpenApi へのステップバイステップの移行: AddSwaggerGen を AddOpenApi に置き換え、操作・スキーマ・ドキュメントのフィルターをトランスフォーマーに変換し、UI を残し、噛みついてくる Microsoft.OpenApi v2 の破壊的変更を扱います。

Swashbuckle は ASP.NET Core のテンプレートから消えました。.NET 11 で組み込みパッケージ Microsoft.AspNetCore.OpenApi を使って OpenAPI ドキュメントを生成し提供する方法を解説します: AddOpenApi、MapOpenApi、トランスフォーマー、複数ドキュメント、ビルド時生成、その上に載せる UI。

.NET 11 Preview 4 により、ASP.NET Core の OpenAPI 生成は HTTP QUERY を OpenAPI 3.2 の第一級の操作として認識するようになり、3.0 と 3.1 のドキュメントには適切なフォールバックが用意されます。

Asp.Versioning 10.0 は .NET 10 と新しい Microsoft.AspNetCore.OpenApi パイプラインを対象とする最初のリリースです。4 月 23 日の Sander ten Brinke の解説では、WithDocumentPerVersion() を使って API バージョンごとに OpenAPI ドキュメントを 1 つずつ登録する方法を紹介しています。

.NET 11 では OpenAPI ドキュメントは Microsoft.AspNetCore.OpenApi が生成し、Swagger UI はテンプレートに含まれません。Bearer、PKCE 付き OAuth2、OpenID Connect を Authorize ボタンが実際に動くように接続する方法を解説します。

Microsoft 公式の OpenAPI コードジェネレーターである Kiota を使って、任意の OpenAPI 仕様から fluent で強く型付けされた C# クライアントを生成します。インストール、生成、ASP.NET Core DI への組み込み、認証設定まで順を追って解説します。