将WebApiTestClient添加到ASP.NET Web API帮助页面

---

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”）。

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

1. @Html.DisplayForModel("TestClientDialogs")  
2. @section Scripts{  
3.     <link href='~/Areas/HelpPage/HelpPage.css' rel='stylesheet' />  
4.     @Html.DisplayForModel("TestClientReferences")  
5. } 

您需要安装以下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/