Abp框架(一) ：為Swagger接口頁添加詳細注釋

從Abp官網創建完項目之后，啟動之后，Swagger的接口說明頁，默認是沒有接口說明的，這樣是很不友好的，也不利於接口調用者的使用，所以，我們要實現Swagger頁面的接口注釋功能。

BP中已經集成了Swagger，ABP中Swagger，支持動態映射應用層，也就是，無需創建控制器。那么對於自動生成的接口中我們的字段說明和接口說明如何添加呢
首先，我們看一下默認啟動后，Swagger的接口頁面，標紅的是我們自己寫的獲取所有組織機構的接口，默認是沒有注釋的。

接下來，我們選中我們Application層的項目，右鍵“屬性”，勾選為Xml生成文檔，如下圖所示。

  接下來，在你的 項目名.Web.Host 的startup目錄下，找到StartUp.cs類，在它的ConfigureServices方法中，找到services.AddSwaggerGen 方法，將生成的Xml配置進去。核心代碼如下：

// Set the comments path for the Swagger JSON and UI.
 var xmlFile = @"SCBC.SMES.Application.xml";
 var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
 options.IncludeXmlComments(xmlPath,true);

然后再啟動項目，可以看到我們的接口有注釋啦！！