ASP .NET C# MVC4 寫 Api 自定api說明文件 利用HelpPage套件

STEP1. ASP.NET Web API 的相關路由設定
 App_Start\WebApiConfig.cs 檔案

讓我們的 ASP.NET Web API 永遠只回應 JSON 格式

setp2.替 ASP.NET Web API 的 API 控制器加上註解

我們先為 API 控制器加上 XML 註解，直接在類別上方輸入三條斜線 ( /// ) 就會自動產生 XML 註解範本

setp3.產生專案的 XML 文件檔案
修改方案總管中的「專案屬性」

切換到「建置」頁籤，再勾選「XML 文件檔案」

預設的 XML 文件檔案會儲存在 bin\ 目錄下，請把內容改成 App_Data\XmlDocument.XML 這個路徑與檔名，之後才能讓 ASP.NET Web API 的說明頁面讀取到這個檔案。

最後執行 建置專案 ( F6 ) 就會自動在 App_Data 目錄下產生 XmlDocument.XML 檔案，而且每次建置都會自動更新此 XML 文件。

step4.透過 NuGet 安裝 Microsoft.AspNet.WebApi.HelpPage 套件

若要安裝 ASP.NET MVC 4 內建的 ASP.NET Web API ( v1 ) 相容的 HelpPage 版本，必須安裝舊版的 HelpPage  套件。

安裝舊版套件需要透過套件管理器主控台才能執行安裝命令，如下指令與圖示：

Install-Package Microsoft.AspNet.WebApi.HelpPage -Version 4.0.30506

安裝的過程，它會自動幫你安裝一個名為 HelpPage 的 MVC 子網站 ( Area )

最後，我們開啟 Areas/HelpPage/App_Start/HelpPageConfig.cs 進行設定，把第一行註解取消，即可自動讀入 API 控制器所設定的那些 XML 文件。

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

其重點還是在上述陳述式的路徑與檔名必須正確：

"~/App_Data/XmlDocument.xml"

setp4.

我們測試一下，直接瀏覽到 http://localhost/Help 網址

接下來你可以到 專案 的view的資料夾內 index中
加入聯接過去的方法
<a href="~/Help">API Document 說明書請點這裡</a>



最後小提醒

在撰寫注解的時候<param name =""  如果沒有出來顯示
表示你在你的mvc 方法中沒有設定輸入的參數  只有寫注解他是不會顯示的





參考網頁:http://blog.miniasp.com/post/2013/11/05/Creating-ASPNET-Web-API-Help-Pages-for-ASPNET-MVC-4.aspx