啟用WebApi 2里的Api描述信息(Help下的Description)

-Advertisement-

環境:vs2013+web api 2 問題:預設情況下新建的Web Api 2項目,自帶的Help頁下會顯示Api的相關信息,但Description那一欄無法獲取到數據,如下圖所示: 解決: 1.先啟用輸出的XML文檔文件: 在web api項目上右擊->屬性,在屬性頁"生成"標簽下,勾選輸出下 ...

環境:vs2013+web api 2

問題:預設情況下新建的Web Api 2項目,自帶的Help頁下會顯示Api的相關信息,但Description那一欄無法獲取到數據,如下圖所示:

解決:

1.先啟用輸出的XML文檔文件:

在web api項目上右擊->屬性,在屬性頁"生成"標簽下,勾選輸出下麵的"XML 文檔文件",如下圖所示:

2.在"解決方案管理器"里,打HelpPageConfig.cs,去掉SetDocumentationProvider方法,並把地址改成與1里的對應,如下圖所示:

3.在Api上添加註釋,如下圖所示:

再次運行項目,打開Api Help頁面,就可以看到效果了,如下圖所示:

參考:ASP.NET Web API Help Page documentation using Xml comments on controllers

您的分享是我們最大的動力!

-Advertisement-

更多相關文章

微信JSAPI支付統一下單（.net後臺）

交流QQ群 ASP.NET鷹組 460845632 我會傾囊相授我們要做微信支付當配置好微信微信商戶和支付配置之後我們首先應該看 https://pay.weixin.qq.com/wiki/doc/api/app/app.php?chapter=9_1# 這是微信統一下單的參數，我將這個參數做成 ...
C# MP3播放幫助類

1 /// <summary> 2 /// ************************************************* 3 /// 類名：MP3幫助類 4 /// 修改日期：2016/06/25 5 /// 作者：董兆生 6 /// 聯繫方式：QQ490412323 7 // ...
Ext.Net 學習隨筆 002 預設按鈕

在FormPanel中按回車按鍵，會觸發預設按鈕的click事件。設置方法為在FormPanel中設置DefaultButton屬性，如果沒有設置這個屬性，預設為最後一個按鈕。 1.預設最後一個按鈕為預設按鈕 2.以數字編號指點預設按鈕 3.用ID指定預設按鈕 4.用選擇器指定預設按鈕視圖的完整代 ...
使用VS2015進行C++開發的6個主要原因

使用VS2015進行C++開發的6個主要原因使用Visual Studio 2015進行C++開發在今天的 Build 大會上，進行了“將你的 C++ 代碼轉移至 VS2015 的 6 個原因”的演講，其中探討了 VS2015 中對於 C++ 開發者們更有用的新功能。自從它在 2015 年七月的 ...
C#語言——類

C#——類一、String 類系統內置的處理字元串類型的函數方法類。方便我們對字元串類型進行一系列的處理。 1、Length：獲取字元串的長度，返回一個int類型的值 string x=Console.ReadLine();//小string是大String的快捷方式 int i = x.Len ...
.Net remoting方法實現簡單的線上升級（上篇：更新文件）

一、前言：最近做一個簡單的線上升級Demo，使用了微軟較早的.Net Remoting技術來練手。簡單的思路就是在伺服器配置一個Remoting對象，然後在客戶端來執行Remoting對象中的方法。過程： (1) 讀取本地dll文件的名稱與版本號，與伺服器的進行對比 (2) 確認需要升級的文件 ...
Ext.Net 學習隨筆 001 安裝Ext.Net

Ext.Net版本：4.1.0 Ext.Net官網：ext.net Ext.Net官方演示：mvc.ext.net Ext.Net MVC Example 下載：github.com/extnet/Ext.NET.Examples.MVC Ext.Net Nuget 地址：www.nuget.org ...
C#寫爬蟲，版本V2.1

這次是對2.0的小修補，2.0交互幾乎沒有，這次添加了進度條，和文本框，同時由於取得的鏈接主要會出現錯誤是：webResponse錯誤。針對這種情況，設置了截取錯誤信息，這裡我們不處理，後續直接判定statecode屬性來決定是否還要執行下麵的程式。另外一點變化就是以前是通過將所獲取的網頁存到 ...