C#でOpen APIのSwaggerにXMLコメントを反映したい

1. はじめに

• C#でOpenAPIのAPIドキュメントにコメントを追加したい
• コメントはソースコードのXMLコメントを使用したい

2. 開発環境

• C#
• .NET 6
• Visual Studio 2022
• Windows 11
• Swashbackle.AspNetCore (NuGet)

3. Swashbackle.AspNetCoreのインストール

• NugetよりSwashbackle.AspNetCoreをインストールする
  
  ＊　適用ボタンをクリックする
  

4. プロジェクトのプロパティ変更

• プロジェクトを右クリックして、プロパティを選択する
  

• 「ドキュメントファイル > APIドキュメントファイルを含むファイルを生成します。」にチェックをする
  

5. Program.csの修正

Program.cs

// builder.Services.AddSwaggerGen();
builder.Services.AddSwaggerGen(options =>
{
    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename));
});

6. 動作確認

• Controllerに追加したXMLコメントが反映できた
  

7. 参考文献