---

ASP.NET Web API幫助頁面是一種有用的擴展，可為您的Web API自動生成基于Web的文檔。它使調試變得更容易，因為您可以將幫助頁面中的信息復制/粘貼到Fiddler等工具中，以調用Web API服務并檢查響應。

現在，如果您可以直接在幫助頁面上執行此操作而不離開瀏覽器，這會不會很酷？那么，現在您可以使用Web API測試客戶端軟件包。請注意，它不是微軟發布的官方軟件包。這只是我閑暇時放在一起的簡單原型。

入門

第1步：安裝測試客戶端軟件包

從NuGet包管理器安裝WebApiTestClient包。確保“包括預發布”，然后輸入“WebApiTestClient”并點擊安裝。

一旦安裝了軟件包，它會將以下文件添加到您的項目中：

• Scripts\WebApiTestClient.js
  • Areas\HelpPage\TestClient.css
  • Areas\HelpPage\Views\Help\DisplayTemplates\TestClientDialogs.cshtml
  • Areas\HelpPage\Views\Help\DisplayTemplates\TestClientReferences.cshtml
    
    

如果它尚未安裝，它還將引入ASP.NET Web API幫助頁面包。

步驟2：連接幫助頁面上的測試客戶端

打開文件Api.cshtml（在Areas \ HelpPage \ Views \ Help下）并添加以下內容：

• @ Html.DisplayForModel（ “TestClientDialogs”）
• @ Html.DisplayForModel（ “TestClientReferences”）

請注意，您在腳本部分內的<div>和@ Html.DisplayForModel（“TestClientReferences”）之后添加@ Html.DisplayForModel（“TestClientDialogs”）。

即在文件代碼最后添加以下代碼：

@Html.DisplayForModel("TestClientDialogs")??

@section?Scripts{??

????<link?href='~/Areas/HelpPage/HelpPage.css'?rel='stylesheet'?/>??

????@Html.DisplayForModel("TestClientReferences")??

}?

您需要安裝以下JavaScript庫。如果您使用默認的Web API模板，則應該安裝它們。現在，如果您有不同的版本號，則可以更新TestClientReferences.cshtml中的引用。

• jQuery 1.7.1
• jQuery.UI.Combined 1.8.20
• knockoutjs 2.1.0

一旦所有東西連接正確，您應該會看到API頁面右下角顯示的“測試API”按鈕。

?

測試Web API

現在您可以點擊“測試API”按鈕開始測試API。對于每個URI參數，它將自動提供一個文本框，以便您可以填寫該值而不是編輯URI。請注意，在填入參數值時，URI會自動更新。

點擊發送后，會彈出另一個對話框，向您顯示響應。

添加請求頭

您可以通過點擊“添加標題”來添加額外的請求標題。例如，您可以添加accept標頭“text / xml”以請求XML。

當然，您的Web API將內容作為XML返回。

提供請求正文

對于像POST方法，你可以在提供身體體節。請注意，它將預先填充幫助頁面中的樣本，因此您不需要執行任何復制粘貼操作。

您可以根據支持的媒體類型選擇不同的樣本。例如，選擇application / xml將引入XML示例。請注意，內容類型和內容長度標頭會相應更新。

您可以更改正文的內容，并且內容長度標題將隨著您的輸入而改變！

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

總結

以上是生活随笔為你收集整理的将WebApiTestClient添加到ASP.NET Web API帮助页面的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。