程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> .NET網頁編程 >> ASP.NET >> ASP.NET基礎 >> ASP.NET Web API如何將注釋自動生成幫助文檔

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

編輯:ASP.NET基礎

 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")))

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

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved