给WebAPI的REST接口服务添加测试页面(一)

当使用WebAPI提供REST服务的时候,一个经常进行的操作是对接口进行测试。Asp.net WebAPI框架本身并没有提供这一接口,不过由于提供的是标准的REST服务,是可以非常方便的使用一些第三方的工具的。

我之前经常用的Chrome的Postman插件来进行测试,它可以用来模拟各种Http请求操作。虽然这个工具也算好用,不过由于它只是一个通用的工具,使用它的时候要构建Http报文头,并根据具体API组装消息体,这也是一件比较麻烦的事情。

今天网上闲逛的时候发现了一个更加好用的测试工具Swagger-UI,它专门针对REST接口提供了非常友好的测试界面:

不仅能提供接口列表,还能读取接口的参数列表,提供友好的配置接口:

接口说明,参数说明,参数类型都能都都出来,非常友好,甚至连参数的各个字段的注释都能标记出来,基本上都是一个非常友好的帮助文档了。

更多的示例可以参考它官方Demo:http://petstore.swagger.io/。 用它来进行测试非常简单,直接输入参数就行了,不用费力的构造各种URL和报文,比Postman方便多了。

由于篇幅所限,本文这里就只对Swagger-UI进行了一些简单的介绍,下篇文章中再详细介绍如何将Swagger-UI集成到WebAPI中。

时间: 2024-10-06 01:49:19

给WebAPI的REST接口服务添加测试页面(一)的相关文章

给WebAPI的REST接口添加测试页面(二)

在上篇文章中,我对Swagger-UI的基本功能进行了一些介绍,今天在这里介绍一下如何在WebAPI中集成Swagger-UI.这里以一个简单的CRUD的REST服务为例. 1 /// <summary> 2 /// 用户管理 3 /// </summary> 4 public class UserController : ApiController 5 { 6 static List<User> _users = new List<Controllers.Use

给WebAPI的REST接口添加测试页面(三)

在前面的文章中,我介绍过了通过Swashbuckle在WebAPI中集成Swagger-UI.不过这种方式不适合于最新版的ASP.Net MVC6下的WebAPI,在网上搜了一下,发现了它还有一个专供ASP.Net MVC6 WebAPI使用的版本:https://github.com/domaindrivendev/Ahoy 新版本的使用也不复杂,首先在project.json中添加Swashbuckle的引用: 这里要添加6.0的版本,另外值得注意的地方是,由于目前ASP.Net MVC6有

玩转Windows服务系列&mdash;&mdash;给Windows服务添加COM接口

当我们运行一个Windows服务的时候,一般情况下,我们会选择以非窗口或者非控制台的方式运行,这样,它就只是一个后台程序,没有界面供我们进行交互. 那么当我们想与Windows服务进行实时交互的时候,我们应该怎么做呢? 快速给Windows服务添加实时交互功能的方案 Windows服务是一个进程,而我们用于交互的程序,又是另外一个进程.我们与Windows服务实时交互,其实就是一个进程间通信的问题.所有的进程间通信的方案基本上都适用于实时交互的方案,比如Socket.共享内存.管道.COM等.

创建和调用webapi接口服务文件

前言 源码地址:https://github.com/kmonkey9006/QuickWebApi 现在项目中用的是webapi,其中有以下问题:    1.接口随着开发的增多逐渐增加相当庞大. 2.接口调用时不好管理. 以上是主要问题,对此就衍生了一个想法: 如果每一个接口都一个配置文件来管理,每个配置文件能清晰表示处理接口文件,地址,参数,返回值,那么通过这个配置文件,就能很好的管理起来我们所有的webapi接口不是吗? 有了这个思路之后就有了以下的实现: 具体实现: 1.核心代码 pub

项目梳理6——使用WebApiTestClient为webapi添加测试

1.使用nuget添加WebApiTestClient的引用 2.xxxxx.WebApi\Areas\HelpPage\Views\Help\Api.cshtml页面末尾添加如下代码: 3.显示结果 此测试永远无法代替单元测试!!!,单元测试不可少

飞信免费发送接口API的测试 httpClient

测试飞信免费发送接口API的测试(HTTPClient实现) 使用优点:快捷,方便 使用缺点:用户的各种信息以明文形式在网络中传输不安全. 仅仅用于测试 package cn.com.vnvtrip.fection.sms.utils; import java.io.File;import java.io.FileInputStream;import java.io.IOException;import java.io.InputStream;import java.util.Propertie

shareplex的安装&amp;&amp;起停服务(添加新用户)

一.主机环境 主从类型 系统版本 数据库版本 主机地址 主机名 源数据库 Centos6.4 X86_64 11.2.0.4.0 192.168.3.230 dbshareplex 目的数据库 Centos6.4 X86_64     11.2.0.4.0 192.168.3.223 dbshareplexbk 二.环境说明 为了方便测试,两边的数据库都是初始化,除了系统用户没有多余的用户,也没有任何数据 三.环境配置   1.主机名的设置 先将源和目的主机中,分别添加对方的主机名和ip 2.源

调用URL 接口服务

1.Net调用URL 接口服务 using System; using System.Collections; using System.Configuration; using System.Data; using System.Web; using System.Web.Security; using System.Web.UI; using System.Web.UI.HtmlControls; using System.Web.UI.WebControls; using System.W

FF.PyAdmin 接口服务/后台管理微框架 (Flask+LayUI)

源码(有兴趣的朋友请Star一下) github: https://github.com/fufuok/FF.PyAdmin gitee: https://gitee.com/fufuok/FF.PyAdmin 初衷 运维开发中, 各类接口服务和后台管理系统必不可少, 索性写个通用的/简单易用的/支持快速开发的微框架. 一是开发时尽可能只关注业务逻辑, 快速实现, 不用再过多考虑架构/前端/布局什么的. 二是将常用业务逻辑二次封装, 使用时, 用简洁的语句即可完成复杂的事务, 并自动处理异常.