RESTClient 使用教程

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

JAR包： restclient.jar；

支持的Java版本 >=1.7

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

RESTClient主窗体包含：

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

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

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

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

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

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

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

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

可以根据REST API定义要求，以键值对的形式添加相应的Cookie。如果API需要登录认证，请先使用浏览器完成API登录认证成功后，将浏览器生成的JSESSIONID填写到Cookie中，这样就可以无需登录认证，直接访问REST API了，免登陆使用详情参考资料。Cookie键值对示例：

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

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

响应数据如图所示：

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

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

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

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

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

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

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

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

在API编辑窗体中，可以编辑如下内容：

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

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

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

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

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

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

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