給WebAPI項目加上一個說明文檔以及一個測試按鈕


 

首先一般情況下你新建一個webAPI項目后會有一個Areas/HelpPage 的目錄存在,這就是webAPI的說明文當的頁面

如下圖

如果沒有:沒有關系,打開Nuget包管理器的控制台 輸入  Install-Package Microsoft.AspNet.WebApi.HelpPage 完成安裝后 你就可以看到上述文件夾了,這一步只是裝好了 

展示WEBAPI文檔的東東,

下一步安裝TestAPI的插件,這個插件會在頁面生成一個按鈕,點擊這個按鈕可以直接調試WEBAPI 方便到爆炸。

打開Nuget包管理器的控制台 輸入  Install-Package WebApiTestClient  按成安裝后多了這兩個文件

接下來做一些修改,添加一些代碼,找到 Api.cshtml 文件

添加紅框中的內容

到此結束,你會發現 WEBAPI的文檔說明界面右下角多了一個TestAPI的按鈕

然后你會發現一切都是英文,那么怎么顯示中文說明呢

首先 選中項目,右鍵-屬性-生成 選擇下面的XML文檔文件,目錄填寫如下圖所示

然后打開這個文件

取消注釋 並修改XML文件路徑 完成后如下

然后在API的控制器上的寫上 中文注釋 就可以顯示了。

上述步驟做完后,編譯一下你會發現有很多warring ,看着比較煩

 

 禁止顯示這個警告就行了。

然后你就可以愉快的調試了,完!

參考鏈接:

http://www.360doc.com/content/14/0919/09/10504424_410619112.shtml

https://blogs.msdn.microsoft.com/yaohuang1/2012/12/02/adding-a-simple-test-client-to-asp-net-web-api-help-page/

 

推薦使用swagger


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM