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 Web API項目
- ASP.NET中Web API的簡單實例
- ASP.NET MVC Web API HttpClient簡介
- ASP.NET Web Api 2實現多文件打包并下載文件的實例
- 支持Ajax跨域訪問ASP.NET Web Api 2(Cors)的示例教程
- ASP.NET Web API教程 創建Admin視圖詳細介紹
- ASP.NET Web API教程 創建Admin控制器實例分享
- ASP.NET Web API教程 創建域模型的方法詳細介紹
- .Net Web Api中利用FluentValidate進行參數驗證的方法
