ASP.NET Core(36)はSwaggerの代わりにScalarを使ってAPIドキュメントを表示しています

クズども · 掲載地5分前

要件:Scalarは非常に高性能で、APIドキュメントから異なる言語でHTTPコールコードを自動生成できます。APIドキュメントを表示するにはSwaggerの代わりにScalarを使用します。

.NET ASP.NET 9のリリース後、公式CoreチームはSwashbuckle.AspNetCore(ASP.NET Core API用のSwaggerツールを提供するプロジェクト)を ASP.NET Core Web APIテンプレートから削除すると発表しました。これは今後Web APIプロジェクトを作成する際に、Swagger APIのドキュメントが自動的に生成されなくなることを意味します。そこで今日は、EasySQLite .NET 9プロジェクトでScalarを使ってインタラクティブなAPIドキュメントを作成しようと思います。

リンク：ハイパーリンクのログインが見えます。

スワガーの解任理由は以下のようにまとめられます。

Swashbuckleの不十分なメンテナンス:Swashbuckleプロジェクトはもはやコミュニティオーナーによる積極的なメンテナンスを行っておらず、多くの問題が未解決のままであり、.NET 8対応の公式バージョンもリリースされていません。
Microsoft.AspNetCore.OpenApiに目を向けます:ASP.NET CoreチームはMicrosoft.AspNetCore.OpenApiの機能を強化し、Swashbuckleを置き換え、OpenAPIのドキュメント生成を可能にします。
既存の代替手段:Swashbuckleのほか、NSwagのような他のプロジェクトはOpenAPIのドキュメント生成やクライアント/サーバーコード生成をサポートしており、開発者はプロジェクトのニーズに応じて適切なソリューションを選択できます。
強化された組み込みAPIサポート:ASP.NET Core 3.1から、フレームワークはApiExplorerなどのメタデータサポートを提供しています。Visual StudioやVisual Studio Codeの組み込みの.httpファイルサポートと組み合わせることで、APIのテストとデバッグ体験はさらに向上しています。
OpenAPIをコアコンポーネントとして推進:ASP.NET コアチームは.NET 9におけるOpenAPI統合をさらに強化し、JSON形式のOpenAPIドキュメント生成に特化するコアコンポーネントにする計画です。

スカラー

Scalarは、あらゆる規模のAPIプロジェクトに適した、強力で使いやすいAPIクライアントおよびドキュメント生成ツールであり、複数のプログラミング言語やプラットフォームに対応しています。

オープンソースアドレス:ハイパーリンクのログインが見えます。

ASP.NET CoreはScalarを統合します

統合ドキュメント:ハイパーリンクのログインが見えます。

ASP.NET Core 9プロジェクトを作成してください。参照は以下の通りです:

ログインが見えます。

Program.csにサービスとスカラーミドルウェアを追加し、コードは以下の通りです。

ログインが見えます。

コントローラー WeatherForecastController.cs編集、コードは以下の通りです:

ログインが見えます。

プロジェクトを起動し、ブラウザを開き、以下をご覧ください:http://localhost:5088/api-docs、下図に示されているように:

異なる言語でHTTPライブラリごとに特定の呼び出しコードを生成することも可能です。C# HttpClientライブラリを例にすると、生成されるコードは以下の通りです。

また、オンラインインターフェーステストもサポートしています。テストリクエストボタンをクリックし、投稿データを入力し、送信ボタンをクリックしてリクエストを送信してください。以下のように示されています。

デフォルトのHTTPクライアントをカスタマイズしてください。C#チームの場合は、APIドキュメントインターフェースを開き、自動的にC# HttpClientの呼び出しコードを表示したいです。毎回手動で選択したくない場合は、以下のように設定してください:

ログインが見えます。

Ask AI機能を削除し、「Ask AI Agent」ボタンを削除してください。この機能は少し冗長に感じます。コードは以下の通りです:

ログインが見えます。