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