之前在項(xiàng)目中有用到webapi對(duì)外提供接口,發(fā)現(xiàn)在項(xiàng)目中有根據(jù)webapi的方法和注釋自動(dòng)生成幫助文檔,還可以測試webapi方法,功能很是強(qiáng)大,現(xiàn)拿出來與大家分享一下。
先看一下生成的webapi文檔。
1、下圖展示的是生成幫助文檔首頁面,其中Values是controller,API下面的列表展示出請(qǐng)求的http方法(Get,POST等),請(qǐng)求的action,方法的描述。

2、點(diǎn)擊紅框內(nèi)的鏈接,打開api方法的詳情頁面,如下圖所示,

3、點(diǎn)擊Test API打開如下頁面

4、輸入?yún)?shù),點(diǎn)擊Send按鈕,打開如下頁面,可以看到返回值。

設(shè)置的方法步驟如下:
開發(fā)環(huán)境VS2012 + MVC4 + WEB API
1、通過NuGet引用Web API Test Client

引用玩該DLL會(huì)生成如下文件:

這里面就是我們的幫助文檔界面
2、在項(xiàng)目屬性中進(jìn)行如下設(shè)置,勾選xml文檔文件,并設(shè)置路徑

3、在項(xiàng)目的App_Data文件夾下創(chuàng)建XmlDocument.xml
4、打開/Areas/HelpPage/App_Start/HelpPageConfig.cs文件,取消如下代碼注釋

運(yùn)行項(xiàng)目,打開http://localhost:3619/Help,即可看到自動(dòng)生成好的api文檔,即該篇文章的一張圖片
點(diǎn)擊下載項(xiàng)目代碼
參考:http://www.c-sharpcorner.com/UploadFile/2b481f/adding-the-test-api-in-the-asp.net-web-api-help-page/
新聞熱點(diǎn)
疑難解答
圖片精選
網(wǎng)友關(guān)注