ASP.NET Web API如何將注釋自動生成幫助文檔

 ASP.NET Web API從注釋生成幫助文檔

默認(rèn)情況下，ASP.NET Web API不從Controller的注釋中生成幫助文檔。如果要將注釋作為Web API幫助文檔的一部分，比如在幫助文檔的Description欄目中顯示方法注釋中的summary，需要進(jìn)行一些配置操作。

首先在Visual Studio中打開Web API項目的屬性頁，在Build設(shè)置頁，選中XML document file，輸入將要生成的XML文件放置的路徑，比如：App_Data\OpenAPI.XML。

然后編譯項目，就會在對應(yīng)的路徑下生成xml文件。

接著打開 Areas\HelpPage\App_Start\HelpPageConfig.cs 文件，取消 config.SetDocumentationProvider 代碼的注釋，修改一下路徑：

然后重新編譯，訪問 /help 頁面，就能看到效果了。

代碼如下:
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")))

通過以上的簡單介紹，希望對大家有所幫助

聲明：本網(wǎng)頁內(nèi)容旨在傳播知識，若有侵權(quán)等問題請及時與本網(wǎng)聯(lián)系，我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com