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