文章出處
文章列表
默認情況下，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 代碼的注釋，修改一下路徑：
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")));
然后重新編譯，訪問 /help 頁面，就能看到效果了。
文章列表
全站熱搜
留言列表
