将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”)。
即在文件代码最后添加以下代码:
- @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帮助页面相关推荐
- 【ASP.NET Web API教程】2 创建各种Web API
原文 [ASP.NET Web API教程]2 创建各种Web API Chapter 2: Creating Web APIs 第2章 创建各种Web API 本文引自:http://www.asp ...
- [水煮 ASP.NET Web API2 方法论](1-1)在MVC 应用程序中添加 ASP.NET Web API
问题 怎么样将 Asp.Net Web Api 加入到现有的 Asp.Net MVC 项目中 解决方案 在 Visual Studio 2012 中就已经把 Asp.Net Web Api 自动地整合 ...
- ASP.NET Web API自身对CORS的支持:从实例开始
在<通过扩展让ASP.NET Web API支持W3C的CORS规范>中我们通过自定义的HttpMessageHandler为ASP.NET Web API赋予了跨域资源共享的能力,具体来 ...
- ASP.NET Web API实践系列06, 在ASP.NET MVC 4 基础上增加使用ASP.NET WEB API
本篇尝试在现有的ASP.NET MVC 4 项目上增加使用ASP.NET Web API. 新建项目,选择"ASP.NET MVC 4 Web应用程序". 选择"基本&q ...
- ASP.NET Web API 路由对象介绍
前言 在ASP.NET.ASP.NET MVC和ASP.NET Web API这些框架中都会发现有路由的身影,它们的原理都差不多,只不过在不同的环境下作了一些微小的修改,这也是根据每个框架的特性来制定 ...
- A simple Test Client built on top of ASP.NET Web API Help Page
Step 1: Install the Test Client package Install the WebApiTestClient package from the NuGet Package ...
- ASP.NET Web API 过滤器创建、执行过程(二)
ASP.NET Web API 过滤器创建.执行过程(二) 前言 前面一篇中讲解了过滤器执行之前的创建,通过实现IFilterProvider注册到当前的HttpConfiguration里的服务容器 ...
- ASP.NET Web API WebHost宿主环境中管道、路由
ASP.NET Web API WebHost宿主环境中管道.路由 前言 上篇中说到ASP.NET Web API框架在SelfHost环境中管道.路由的一个形态,本篇就来说明一下在WebHost环境 ...
- ASP.NET Web API Selfhost宿主环境中管道、路由
ASP.NET Web API Selfhost宿主环境中管道.路由 前言 前面的几个篇幅对Web API中的路由和管道进行了简单的介绍并没有详细的去说明一些什么,然而ASP.NET Web API这 ...
最新文章
- 人脸、人眼检测与跟踪
- bootstrap课程1 bootstrap为什么这么火
- iOS开发-登录界面开发(6)Toast-Swift的使用-Swfit4.1_Xcode9.3.1
- 存储过程学习三(创建存储过程实例)
- linux只剩 目录挂载,linux(centOS7)的基本操作(五) 磁盘、分区、挂载、卸载
- mysql的limit和or_面试官:谈谈MySQL的limit用法、逻辑分页和物理分页
- 什么是Apple Desktop Bus? 亚行代表什么?
- MySQL进阶(DDL与DML)
- 容器编排技术 -- Kubernetes StatefulSets
- C# Exception 对象的属性
- Python开发环境的搭建(win7)
- 20170831_安装软件
- 饿了么UI框架表格的动态增减表单项里面有坑!
- adb shell top 命令详解
- 【详细】mac下载在线音乐平台的音乐/mp4a转mp3格式
- 个人计算机组装主板,电脑主板安装详细图解 可以自己组装电脑了
- 旋转立方体相册HTML+CSS
- 务器性能变慢 c盘temp文件夹存在大量sess开头文件的问题原因
- eclipse的32位和64位版本(亲测有效)
- PEPL命令-交互式解释器
热门文章
- Dapr牵手.NET学习笔记:Actor小试
- .NET跨平台实践:.NetCore、.Net5/6 Linux守护进程设计
- 有BUG!!!慎用default文本
- 面向.NET开发人员的Dapr——总结和前景
- 技术分享|手机推送原理剖析指南
- 都 2021 年了,竟然有人搞大数据时忽略 JSON 而去研究用 C# 把 XML 转换为 XML 的技术...
- 通过Dapr实现一个简单的基于.net的微服务电商系统(七)——一步一步教你如何撸Dapr之服务限流...
- jwt与token+redis,哪种方案更好用?
- NET问答:Select 和 SelectMany 的区别
- 跟我一起学.NetCore之.NetCore概述