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中打開Web API項(xiàng)目的屬性頁，在Build設(shè)置頁，選中XML document file，輸入將要生成的XML文件放置的路徑，比如：App_Data\OpenAPI.XML。
然后編譯項(xiàng)目，就會(huì)在對(duì)應(yīng)的路徑下生成xml文件。
接著打開 Areas\HelpPage\App_Start\HelpPageConfig.cs 文件，取消 config.SetDocumentationProvider 代碼的注釋，修改一下路徑：
然后重新編譯，訪問 /help 頁面，就能看到效果了。
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")))
通過以上的簡單介紹，希望對(duì)大家有所幫助
相關(guān)文章
asp.net 讀取Excel數(shù)據(jù)到DataTable的代碼
asp.net 讀取Excel數(shù)據(jù)到DataTable的代碼，需要的朋友可以參考下。2010-03-03
ASP.NET 2.0下的條件編譯...2006-09-09
Log4net在.Net?Winform項(xiàng)目中的使用實(shí)例詳解
Log4net是一個(gè)流行的日志記錄工具，可以幫助開發(fā)人員在應(yīng)用程序中實(shí)現(xiàn)高效的日志記錄，本文將提供一個(gè)詳細(xì)的分步驟示例，來幫助您在.Net Winform項(xiàng)目中使用Log4net，感興趣的朋友一起看看吧2023-08-08
輕量級(jí)ORM框架Dapper應(yīng)用之安裝Dapper
這篇文章介紹了輕量級(jí)ORM框架Dapper的安裝方法，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-03-03
JQuery實(shí)現(xiàn)Repeater無刷新批量刪除(附后臺(tái)asp.net源碼)
JQuery實(shí)現(xiàn)Repeater無刷新批量刪除(附后臺(tái)asp.net源碼) ，學(xué)習(xí)jquery的朋友可以參考下。2011-09-09
asp.net下利用JS實(shí)現(xiàn)對(duì)后臺(tái)CS代碼的調(diào)用方法
asp.net下利用JS實(shí)現(xiàn)對(duì)后臺(tái)CS代碼的調(diào)用方法...2007-04-04
如何取得Repeater控件選擇的項(xiàng)目及注意事項(xiàng)
Repeater控件，每個(gè)item前有一個(gè)CheckBox，把選擇的item列顯出來,有兩個(gè)地方需要注意的，就是CheckBox與Label，這個(gè)Label是隨你需要獲取的內(nèi)容而變化喔。如你想獲取Nickname,那你需要把綁定的的內(nèi)容放在Label上2013-01-01
這篇文章主要為大家詳細(xì)介紹了Visual Studio 2017安裝失敗的解決方法，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-04-04
這篇文章介紹了.Net Core靜態(tài)文件資源的使用方法，文中通過示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2022-07-07
小心！ASP.NET網(wǎng)站發(fā)布時(shí)的那些坑
ASP.NET網(wǎng)站發(fā)布時(shí)的那些坑，要小心了，為什么網(wǎng)站發(fā)布后，每個(gè)頁面第一次打開都很卡？ASP.NET session 頻繁丟失如何解決？具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-04-04