1. 程式人生 > >webAPI 自動生成幫助文件

webAPI 自動生成幫助文件

之前在專案中有用到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/