ASP.NET WebAPI 自動生成幫助文檔


當您創建一個Web API,建立了一個幫助頁面非常有用。可以手動創建的所有文件,但最好是能夠自動生成。

為了使這項工作更容易,ASP.NET Web API提供了自動生成幫助頁面的模板,如下圖

 

如何創建Help Page?

1、用VS2013創建的Web API 2項目會默認帶有Microsoft ASP.NET Web API Help Page的包。如果沒有,就需要手動去NuGet上安裝。

 

 

2、 如果安裝了這個包,創建新的Web API 項目后,Web API項目目錄里會多一個Area,里面有個HelpPage文件夾,這里面放的都是HelpPage生成器的代碼、頁面模版和配置文件。

當你運行應用程序時,主頁上包含一個鏈接到API幫助頁面。

 

3、 “Description”字段的內容,是需要去配置的,Description的內容所使用的其實是代碼里方法的注釋,即/// <summary>形式的注釋。這些東西是可以生成XML的,許多文檔生成器都要使用這份XML作為metadata的來源。

在我們的網站里,這樣的metadata信息通常應該放在App_Data文件夾里,而不是默認的bin目錄里。所以我們要對Web API的項目屬性做一些更改。

打開項目屬性,在Build頁面里,勾選XML documentation file,並把他放到App_Data下面:

 

取消Register方法中第一段代碼的注釋,並且把XML文件的路徑改成剛才在剛才在項目屬性頁里設置的路徑。

    config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/PatientView.Service.WebAPI.xml")));

現在,如果你在API方法上添加/// <summary>的注釋,就會被生成在網頁上。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM