ASP.NET WebAPI 自動生成幫助文檔

當您建立一個Web API，創建了一個幫助頁面很是有用。能夠手動建立的全部文件，但最好是可以自動生成。

爲了使這項工做更容易，ASP.NET Web API提供了自動生成幫助頁面的模板，以下圖

 

如何建立Help Page？

一、用VS2013建立的Web API 2項目會默認帶有Microsoft ASP.NET Web API Help Page的包。若是沒有，就須要手動去NuGet上安裝。

 

 

二、 若是安裝了這個包，建立新的Web API 項目後，Web API項目目錄裏會多一個Area，裏面有個HelpPage文件夾，這裏面放的都是HelpPage生成器的代碼、頁面模版和配置文件。

當你運行應用程序時，主頁上包含一個連接到API幫助頁面。

 

三、 「Description」字段的內容，是須要去配置的，Description的內容所使用的實際上是代碼裏方法的註釋，即/// <summary>形式的註釋。這些東西是能夠生成XML的，許多文檔生成器都要使用這份XML做爲metadata的來源。

在咱們的網站裏，這樣的metadata信息一般應該放在App_Data文件夾裏，而不是默認的bin目錄裏。因此咱們要對Web API的項目屬性作一些更改。

打開項目屬性，在Build頁面裏，勾選XML documentation file，並把他放到App_Data下面：

 

取消Register方法中第一段代碼的註釋，而且把XML文件的路徑改爲剛纔在剛纔在項目屬性頁裏設置的路徑。

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

如今，若是你在API方法上添加/// <summary>的註釋，就會被生成在網頁上。