SwaggerのC#での使い方は何ですか?
SwaggerをC#で使用するには、NuGetパッケージマネージャを使用してSwashbuckle.AspNetCoreライブラリをインストールする必要があります。以下は基本的な手順です。
- Visual Studioを開き、ASP.NET Core Web APIプロジェクトを作成してください。
- NuGetパッケージマネージャーでSwashbuckle.AspNetCoreライブラリを検索してインストールしてください。
- Startup.csファイルのConfigureServicesメソッドにSwaggerサービスの設定を追加します。
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
- Startup.csファイルのConfigureメソッドでSwaggerミドルウェアを有効にする:
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
- プロジェクトを起動し、/swagger/index.htmlにアクセスすると、生成されたAPIドキュメントを確認できます。
Swaggerを使用すると、APIの定義やパラメータ、リクエスト、レスポンスなどの情報を簡単に確認できるだけでなく、SwaggerUIを使用してインタラクティブなAPIテストを行うこともできます。