Web 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 文檔說明的前提是你的 寫注釋!!!!!

 

 

--------------------------------------------------------------------華麗麗的分割線---------------------------------------------------------------------------------------------------------

Update :

這樣之后,你生成項目一看,幾百個警告:警告    2    缺少對公共可見類型或成員“XXX.XXXXX.XXX”的 XML 注釋    D:\XXXX\XXX\SampleDirection.cs    什么的
說的很清楚,對,就是你沒給 屬性和類 加上注釋,怎么辦呢?一條一條加注釋,顯然不可能。

於是,選中項目,右鍵屬性,禁止顯示警告輸入:1591,如圖:

 

在生成一下看看就OK了

 

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM