ASP.NET Web API如何將注釋自動生成幫助文檔
更新時間：2015年07月20日 17:27:03 作者：dudu
本篇文章主要介紹了ASP.NET Web API從注釋自動生成幫助文檔的方法，功能很是強大，現與大家分享一下,需要的朋友可以參考下
ASP.NET Web API從注釋生成幫助文檔
默認情況下，ASP.NET Web API不從Controller的注釋中生成幫助文檔。如果要將注釋作為Web API幫助文檔的一部分，比如在幫助文檔的Description欄目中顯示方法注釋中的summary，需要進行一些配置操作。
首先在Visual Studio中打開Web API項目的屬性頁，在Build設置頁，選中XML document file，輸入將要生成的XML文件放置的路徑，比如：App_Data\OpenAPI.XML。
然后編譯項目，就會在對應的路徑下生成xml文件。
接著打開 Areas\HelpPage\App_Start\HelpPageConfig.cs 文件，取消 config.SetDocumentationProvider 代碼的注釋，修改一下路徑：
然后重新編譯，訪問 /help 頁面，就能看到效果了。
復制代碼 代碼如下:
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")))
通過以上的簡單介紹，希望對大家有所幫助
相關文章
這些內容是我在學習ASP.Net的時候對Page研究的一些心得，具體的細節(jié)沒有很詳細的探討，更多的內容請大家參考MSDN，但是我舉了一些初學者常犯的錯誤和出現錯誤的原因，希望可以給大家?guī)韱l(fā)。2009-08-08
這篇文章主要介紹了php基礎練習--簡單驗證碼實現,需要的朋友可以參考下2014-02-02
這篇文章主要介紹了Asp.net基于ajax和jquery-ui實現進度條,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-12-12
Asp.net MVC中使用JQuery插件ajaxFileUpload上傳文件
這篇文章主要介紹了Asp.net MVC中使用JQuery插件ajaxFileUpload上傳文件,需要的朋友可以參考下2016-08-08
Equals和==的區(qū)別 公共變量和屬性的區(qū)別小結
Equals 和==的區(qū)別 公共變量和屬性的區(qū)別 總結一下。2009-11-11
這篇文章主要介紹了淺談asp.net Forms身份驗證詳解 ，這種方法可以輕松的保持用戶的登錄狀態(tài)（如果用戶想這樣），便捷的用戶授權配置，增強的安全性，有興趣的可以了解一下。2016-12-12
這篇文章主要介紹了在.NET?6.0中自定義接口路由,在本文，我們學習了如何使用終止中間件組件作為接口，并用將該接口映射到新的路由引擎，從而讓我們的路由變得更加強大和靈活，需要的朋友可以參考下2023-04-04
詳解.NET中的加密算法總結(自定義加密Helper類續(xù))
這篇文章主要介紹了詳解.NET中的加密算法總結(自定義加密Helper類續(xù)) ，具有一定的參考價值，感興趣的小伙伴們可以參考一下。2016-12-12
WPF是微軟推出的基于Windows的用戶界面框架，這篇文章介紹了WPF的基礎開發(fā)，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-02-02
javascript判斷是否有對RadioButtonList選項選擇
寫個Javascript來判斷是否有對RadioButtonList選項選擇,附動畫演示，感興趣的朋友可以了解下，希望對您們有幫助2013-01-01