asp.net webAPI 自動產生協助文檔並測試

標籤：blog   http   io   ar   os   sp   strong   檔案   on   

之前在項目中有用到webapi對外提供介面，發現在項目中有根據webapi的方法和注釋自動產生協助文檔，還可以測試webapi方法，功能很是強大，現拿出來與大家分享一下。

先看一下產生的webapi文檔。

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

2、點擊紅框內的連結，開啟api方法的詳情頁面，如所示，

3、點擊Test API開啟如下頁面

 

4、輸入參數，點擊Send按鈕，開啟如下頁面，可以看到傳回值。

 

設定的方法步驟如下：

開發環境VS2012 + MVC4 + WEB API

1、通過NuGet引用Web API Test Client

 

引用玩該DLL會產生如下檔案：

這裡面就是我們的協助文檔介面

 

 

2、在項目屬性中進行如下設定，勾選XMl文檔檔案，並設定路徑

3、在項目的App_Data檔案夾下建立XmlDocument.xml

4、開啟\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/

asp.net webAPI 自動產生協助文檔並測試