三：.net core（.NET 6）給swagger添加文檔注釋詳細步驟

提供swagger文檔注釋。

0、先給api加上標題注釋和返回值注釋：

 

 

 

然后，啟動見證奇跡：

 

 

What the hell？沒得注釋？查看當前自動生成的swagger代碼如下：

 

 

首先，我們需要對需要注釋的地方，添加xml文檔。右鍵項目屬性，生成下面，對XML文檔進行打鈎，會自動生成一個xml文檔。

 

 

 

然后右鍵項目，生成以后，項目下面多出一個xml文件，右鍵xml文件到屬性，選擇始終復制。如果沒有點始終復制，將來發布到其他地方時候，有可能不會帶出xml文檔，輕則swagger不會顯示注釋，重則頁面打開會報錯文件丟失等。

 

 

 

然后，把一些代碼也做下更改：

 

 

 代碼如下：

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

            });

 

現在再次見證一下奇跡：

 

哦吼，注釋全出來了，以及代碼里面寫的標題、描述版本號等也在對應的區域顯示出對應效果。到此結束。