ASP.NET Web API從注釋產生協助文檔

標籤：

預設情況下，ASP.NET Web API不從Controller的注釋中產生協助文檔。如果要將注釋作為Web API協助文檔的一部分，比如在協助文檔的Description欄目中顯示方法注釋中的summary，需要進行一些配置操作。

首先在Visual Studio中開啟Web API項目的屬性頁面，在Build設定頁，選中XML document file，輸入將要產生的XML檔案放置的路徑，比如：App_Data\OpenAPI.XML。

然後編譯項目，就會在對應的路徑下產生xml檔案。

接著開啟 Areas\HelpPage\App_Start\HelpPageConfig.cs 檔案，取消 config.SetDocumentationProvider 代碼的注釋，修改一下路徑：

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")));

然後重新編譯，訪問 /help 頁面，就能看到效果了。

ASP.NET Web API從注釋產生協助文檔