1. 程式人生 > >MVC WebAPI自動生成幫助文檔(轉)

MVC WebAPI自動生成幫助文檔(轉)

context htm 。。 註意點 一行代碼 mappath strong image current

註意點:

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自動生成幫助文檔(轉)