webAPI 自動生成幫助文檔

以前在項目中有用到webapi對外提供接口，發如今項目中有根據webapi的方法和註釋自動生成幫助文檔，還能夠測試webapi方法，功能非常強大，現拿出來與你們分享一下。

先看一下生成的webapi文檔。

一、下圖展現的是生成幫助文檔首頁面，其中Values是controller，API下面的列表展現出請求的http方法(Get,POST等)，請求的action，方法的描述。

二、點擊紅框內的連接，打開api方法的詳情頁面，以下圖所示，

三、點擊Test API打開以下頁面

 

四、輸入參數，點擊Send按鈕，打開以下頁面，能夠看到返回值。

 

設置的方法步驟以下：

開發環境VS2012 + MVC4 + WEB API

一、經過NuGet引用Web API Test Client

 

引用玩該DLL會生成以下文件：

這裏面就是咱們的幫助文檔界面

 

 

二、在項目屬性中進行以下設置，勾選XMl文檔文件，並設置路徑

三、在項目的App_Data文件夾下建立XmlDocument.xml

四、打開\Areas\HelpPage\App_Start\HelpPageConfig.cs文件，取消以下代碼註釋

 

運行項目，打開http://localhost:3619/Help，便可看到自動生成好的api文檔，即該篇文章的一張圖片

點擊下載項目代碼

參考：http://www.c-sharpcorner.com/UploadFile/2b481f/adding-the-test-api-in-the-Asp-Net-web-api-help-page/