Wisdom RESTClient 一款自动化测试REST API的工具,它可以自动化测试RESTful API并生成精美的测试报告,同时基于测试过的历史API,可以生成精美的RESTful API文档。

1. 使用RESTClient前的准备工作

1.1 下载RESTClient

JAR包: restclient.jar

1.2 使用前安装Java

支持的Java版本 >=1.7

1.3 启动RESTClient软件

双击restclient.jar,或者执行命令java -jar restclient.jar启动RESTClient软件。

RESTClient主窗体包含:

  • 请求视图(Request)
  • 响应视图(Response)
  • 历史视图(History)
  • 菜单栏(File, Edit, Test, Apidoc, Help)

2. 使用RESTClient测试REST API步骤

2.1 请求视图中输入REST API所需的请求数据

在请求视图中对所测试的REST API输入的数据详情如下:

2.1.1 选择请求方法

RESTClient支持请求方法详情如下:

方法名 操作 备注
GET 查询 无需要填写请求体
POST 添加
PUT 修改
DELETE 删除 无需要填写请求体

2.1.2 输入访问REST API的URL

  • URL格式: HTTP协议://主机名:端口号/路径

  • URL示例: http://restclient.cn:8080/restapi

2.1.3 输入请求体(Body)

如果选择的请求方法是POST或者PUT则可以填写请求体,其他方法则无需填写

2.1.3.1 选择请求体类型(Body-Type)

  • 字符串(String)

    直接在请求体的文本框中填写字符串;

  • 文件(File)

    浏览并选择地文本文件,文件内容会被读取并作为请求体。

2.1.3.2 选择内容类型(Content-Type)

根据REST API消息体类型,对照下表,选择跟API匹配的内容类型,如果表中的内容类型都不是API所需要的类型,可以直接在内容类型文本框中输入所需类型

常见的内容类型详情如下:

内容类型(Content-Type) 数据格式
application/json JSON
application/xml XML
application/x-www-form-urlencoded Form表单
text/plain 纯文本
text/xml XML文本
text/html HTML文本
multipart/form-data 用于上传文件
application/xhtml+xml XHTML

2.1.4 选择字符集(Charset)

默认字符集是UTF-8,可以选择REST API所需要的字符集,如果下拉列表里的字符集都不是API所需要的,可以直接在字符集文本框中输入所需的字符集

2.1.5 填写消息头(Header)

可以根据REST API定义要求,以键值对的形式添加相应的消息头。

Header键值对示例:

Key   : Accept
Value : application/json

2.1.6 填写Cookie

可以根据REST API定义要求,以键值对的形式添加相应的Cookie。

如果API需要登录认证,请先使用浏览器完成API登录认证成功后,将浏览器生成的JSESSIONID填写到Cookie中,这样就可以无需登录认证,直接访问REST API了,免登陆使用详情参考资料

Cookie键值对示例:

Key   :JSESSIONID
Value : MY0REST1COOKIE2DEMO3

2.1.7 完整的请求数据示例

填写完请求数据后点击Start按钮会触发API请求,在请求视图中输入完整的请求数据如图所示:

2.2 响应视图中返回REST API响应的数据

REST API请求完成后得到响应数据如下:

  • 响应状态码(Status)
  • 响应消息体(Body)
  • 响应消息头(Header)
  • 原始的响应数据(Raw)

响应数据如图所示:

2.3 历史视图中记录测试过的REST API

在历史视图中可以对API进行的可视化编辑如下:

  • 刷新API
  • 对选中的API进行顺序调整
  • 删除选中的API或者清空全部历史API
  • 可以编辑选中的API

历史API可视化编辑的快捷菜单如图所示:

2.4 对历史REST API进行再测试

如果需要对历史API进行再测试,在RESTClient菜单栏点击 Test => Start Test

记录的历史API测试完成后,在Windows系统中会使用默认的浏览器打开测试报告。其他系统可以根据提示框中的报告路径,手动打开测试报告。

测试报告如图所示:

2.5 对历史REST API生成API文档

如果需要生成API文档,在RESTClient菜单栏点击 Apidoc => Create

API文档生成完成后,在Windows系统中会使用默认的浏览器打开API文档。其他系统可以根据提示框中的文档路径,手动打开API文档。

API文档如图所示:

2.6 对历史REST API进行编辑

为了满足API再测试要求或者满足API文档数据要求,可以对API进行如下操作:

  • 调整API顺序
  • 删除冗余的、废弃的API
  • 对API进行可视化编辑

历史视图中选中API,快捷菜单中选择Edit打开API编辑窗体,如图所示:

在API编辑窗体中,可以编辑如下内容:

  • 请求方法
  • 请求URL
  • 请求头(Header)
  • 请求体(Body)
  • 响应状态码(Status)
  • 响应的消息体(Text视图)
  • 是否校验返回的消息体(Assert Body)

默认勾选了Assert Body,API再测试会对返回的消息体进行完整匹配校验,如果不需要对返回的消息体进行匹配校验,可以去勾选。

如果返回的消息体中的某些JSON节点不需要进行再测试匹配校验,可以在Viewer视图上勾选排除这些节点,这样API再测试只对未排除的节点进行匹配校验。

2.7 定制API文档

如果生成的API文档不能满足要求,需要改动,可以修改数据文件work/apidoc/js/apidata.js来定制API文档,API定制详情可以参考资料

2.8 通过命令行(CLI)方式使用RESTClient实现自动化测试REST API

RESTClient支持通过执行命令的方式启动和再测试API以及生成API文档,RESTClient CLI使用详情参考资料

通过CLI方式,这样很容易在Jenkins中定时执行命令来调度RESTClient进行API再测试,从而实现自动化测试REST API和生成REST API文档。

3. 问题咨询与帮助

使用RESTClient过程中遇到问题可以查看RESTClient日志文件:work/log/rest-client.log,这样很容易排查出问题的具体原因。

更多的RESTClient使用示例,请参考相关的技术资料来获得更多的使用示例和帮助。

RESTClient 使用的更多相关文章

  1. Openstack api 学习文档 & restclient使用文档

    Openstack api 学习文档 & restclient使用文档 转载请注明http://www.cnblogs.com/juandx/p/4943409.html 这篇文档总结一下我初 ...

  2. 基于springmvc和restClient的rest服务的测试

    在开发中,不熟悉驱动驱动测试开发的coder往往喜欢将服务应用启动以后测试,对于GET请求可以直接在浏览器中输入URL就可以,参数非中文可以直接追加到URL后.但是,对于其他请求方式的测试必须借助相应 ...

  3. restClient访问SSL

    IRestClient client = new RestClient("https://xxx.com/aa/bb"); "; ); ServicePointManag ...

  4. 使用RESTClient插件进行数据模拟(GET,POST)提交

    1:在Firefox中下载RESTClient插件安装 2:安装好后的界面 (chrome://restclient/content/restclient.html) 3:选择GET/POST,输入U ...

  5. RESTClient使用

    RESTClient使用

  6. rspec+rest-client测试第三方web service

    如果你手工测试Restful 服务将会是一件非常单调乏味的事情.当然,目前有一些浏览器插件可以通过可视化的界面帮助你手工测试,例如postman.rest console,但是每次系统版本更新,你都需 ...

  7. RESTClient - firefox插件

    地址:https://addons.mozilla.org/zh-CN/firefox/addon/restclient/ 关于此附加组件 RESTClient是一款用于测试各种Web服务的插件,它可 ...

  8. 使用Mozilla Firefox插件RestClient测试Http API接口

    RESTClient是Mozilla Firefox一个用于测试http请求插件.在火狐附加组件里面查询并安装,非常小巧,界面非常简单,使用非常的方便,看下面这张图你就全明白了,希望对新手有帮助! 1 ...

  9. 使用火狐的restclient发送http接口post及get请求

    1.在firefox安装restclient插件,具体参照http://jingyan.baidu.com/article/1876c8529b07e3890b137623.html: —.发送pos ...

  10. 火狐restclient

    RESTClient是一款用于测试各种Web服务的插件,它可以向服务器发送各种HTTP请求(用户也可以自定义请求方式),并显示服务器响应.使用RESTClient您可以方便的测试各种Web服务,为您的 ...

随机推荐

  1. javascript的数组之join()

    join()方法将一个数组(或一个类数组对象)的所有元素根据传入的参数连接成一个字符串,并返回这个字符串. var elements = ['Fire', 'Wind', 'Rain']; conso ...

  2. Python自学知识点----Day02

    Linux基本操作命令: 命令                                    作用                                     英文释义 ls    ...

  3. tomcat多实例

    //结合博主之前的安装tomcat的博文一起看,tomcat多实例就是在不同路径启动多个tomcat,然后在本机不同端口启动 [root@ycj ~]# cd /usr/local/src/ [roo ...

  4. Java演算法-「雞兔同籠問題」

    /** * 雞兔同籠問題:窮舉算法思想 */ import java.util.*; public class ChichenAndHabbit { static int chichenNum,hab ...

  5. corefx 源码学习:SqlClient 是如何同步建立 Socket 连接的

    在昨天的技术周会上发现 EnyimMemcached 中建立 Socket 连接的代码有问题,今天坐车的时候在手机上阅读 .net core 2.2 的 SqlClient 中同步建立 Socket ...

  6. ping vs telnet, what is the difference between them and when to use which?

    Ping is an ICMP protocol. Basically any system with TCP/IP could respond to ICMP calls if they were ...

  7. react高阶组件的使用

    为了提高代码的复用在react中我们可以使用高阶组件 1.添加高阶组件 高阶组件主要代码模板HOC.js export default (WrappedComponent) => { retur ...

  8. CF1093F Vasya and Array

    题目链接:洛谷 以后还是要多打CF,不然就会错过这些很好的思维题了.我dp学得还是太烂,要多总结. 首先$len=1$就直接输出0. 我们考虑$dp[i][j]$表示前$i$个数的答案,而且第$i$个 ...

  9. YII - 打印 SQL

    $query = Order::find()->select(['order_sys_id'])->where(['order_car_id'=>'AA','order_status ...

  10. 干了这杯Java之transient关键字

    看源码的时候,发现transient这个关键字,不甚理解,查找资料发现:不被序列化 疑问: 静态变量是不是不被序列化? public class User implements Serializabl ...