ASP.NET Core Web API (.NET 7) は Swagger ページにコメントを追加します

1.Swagger ページを開くと、新しく作成された ASP.NET Core Web API テンプレートにコメントがありません。

インターフェイスに注釈が書かれているが、Swagger ページが表示されない
インターフェイスに注釈が書かれているが、Swagger ページが表示されない
インターフェイスに注釈が書かれているが、Swagger ページが表示されない

2. API ドキュメントを含むファイルを生成する

プロジェクトのプロパティを右クリックし、[ビルド] > [出力] で、API ドキュメントを含むファイルの生成にチェックを入れると、
ここに画像の説明を挿入
次のファイルが生成されます
ここに画像の説明を挿入

3. Program.cs を構成する

次のコードを追加して、主に上記の .xml ファイルが生成された場所を見つけます。

builder.Services.AddSwaggerGen(a =>
{
    
    
    a.SwaggerDoc("v1", new OpenApiInfo {
    
     Title = "练习 测试", Version = "第一版", Description = "描述吧" });
    var curr = AppContext.BaseDirectory;
    a.IncludeXmlComments(curr + "/WebApplication1.xml", true);
});

ここに画像の説明を挿入

4.効果

ここに画像の説明を挿入

おすすめ

転載: blog.csdn.net/sinat_41844660/article/details/128787372