.NET 6 Swagger添加xml注釋

這里我用的是vs2022版本。

1.首先新建一個xml文檔在項目根目錄。

 

 2.然后選擇屬性，始終復制(如果不選擇的話，發布的程序可能會提示缺少xml文件)。

 

3.打開項目屬性，勾選生成api文檔，然后選擇對應的xml文檔路徑。

4.添加注釋。

 

 

5.最后從Program.cs里面加入如下代碼。

 

 

builder.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo
        {
            Title = "這是文檔標題",
            Version = "文檔版本編號",
            Description = "文檔描述"
        });
        var file = Path.Combine(AppContext.BaseDirectory, "XMLFile.xml");  // xml文檔絕對路徑
        var path = Path.Combine(AppContext.BaseDirectory, file); // xml文檔絕對路徑
        c.IncludeXmlComments(path, true); // true : 顯示控制器層注釋
        c.OrderActionsBy(o => o.RelativePath); // 對action的名稱進行排序，如果有多個，就可以看見效果了。
    });

　生成項目，啟動，就可以看見注釋了。