MVC WebAPI自動產生協助文檔(轉)

標籤：web api   vs2012   map   page   首頁   協助文檔   mars   tpc   blog   

注意點：

1.mvc的控制器必須繼承於ApiController，否則看不到的

2. 簡單查看xml，根據第二步即可產生xml，可視感比較低，但是內容全部有，不限定於Api

 

以下為轉載本文

========================================================================================

建立Web Api項目之後，會在首頁有API的導覽功能表，點擊即可看到API協助文檔，不過很遺憾，Description 是沒有內容的。

怎麼辦呢？

第一步：

如果用VS2013 建立項目的（VS2012沒試過），項目中會有 Areas/HelpPage 這樣的目錄，你沒看錯，文檔就是這貨產生的。

如果要是刪除了或者，沒有這個目錄怎麼辦呢？沒關係，你只需要使用NuGet添加  【Microsoft.AspNet.WebApi.HelpPage】這貨，然後你就發現，你的項目自動添加了 Areas/HelpPage這一坨

 

第二步：

選中項目，右鍵，屬性，產生，選擇下面的XML 文檔檔案，目錄自己填寫，如：

 

第三步：

找到 Areas/HelpPage/App_Start  目錄下的HelpPageConfig.cs 檔案，Register 方法，添加一行代碼：

1 config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/Areas/HelpPage/WebApiHelp.XML")));

然後產生一下，啟動項目，點擊API看看

 

然後你就會感覺，自己棒棒噠。。。

 

Ps: 產生API 文檔說明的前提是你的 寫注釋！！！！！

 

 

來自

http://blog.csdn.net/shiyaru1314/article/details/49995547

相關文章推薦

http://www.cnblogs.com/pmars/p/3673654.html

 

MVC WebAPI自動產生協助文檔(轉)