開發隨筆記錄——關於Swagger除錯時API介面註釋顯示問題處理。
阿新 • • 發佈:2021-07-14
宣告:博主在使用Swagger時踩了許多的坑,因此記錄下來與各大網友們進行分享,並以此共勉。
首先基於Swagger已經安裝完畢的基礎上(若還未安裝可以參考博主上一篇文章),在Startup.cs檔案中ConfigureServices方法,在裡面找到services.AddSwaggerGen方法,在其中新增如下程式碼:
// 為 Swagger JSON and UI設定xml文件註釋路徑 var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//獲取應用程式所在目錄(絕對,不受工作目錄影響,建議採用此方法獲取路徑)var xmlPath = Path.Combine(basePath, "PracticeDemo.Api.xml"); // 新增控制器層註釋,true表示顯示控制器註釋 false表示只顯示API介面的註釋 c.IncludeXmlComments(xmlPath,true);
之後在進行XML檔案配置。操作順序:專案右鍵,選擇屬性,勾選“XML文件檔案”,如下圖所示:
之後在控制器中新增各個API、以及控制器的註釋即可。如圖所示:
效果如圖:
/*************注意*************/
在釋出環境中可能會遺失XML檔案,解決方法如下:
在專案csproj檔案中,新增如下程式碼:
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
重新發布即可。