@[TOC](RestfulToolKit:便捷的 IDEA 接口测试神器)
1. RestfulToolKit 介绍
正如文章标题所写,RestfulToolKit 简单来说就是一个用来测试遵循 Restful 风格接口方法的插件工具,使得我们可以不用离开 IDEA 界面就可以完成接口测试工作。那么,它的作者是这样定义的:
它是一套 RESTful 服务开发辅助工具集:
- 根据 URL 直接跳转到对应的方法定义
- 提供了一个
Services tree
的显示窗口 - 一个简单的 http 请求工具
- 在请求方法上添加了有用功能: 复制生成 URL、复制方法参数..
- 其他功能: java 类上添加 Convert to JSON 功能,格式化 json 数据(Windows:
Ctrl + Enter
; Mac:Command + Enter
) - 支持 Spring 体系 (Spring MVC / Spring Boot 1.x,2.x)
- 支持 JAX-RS
- 支持 Java 和 Kotlin 语言
2. 安装 RestfulToolKit
首先 ,打开 IDEA 设置窗口(File->Settings ),并选择 Plugins->Marketplace,切换到插件应用市场界面
之后 ,在搜索栏中输入 RestfulToolKit
,在显示出现的搜索结果选择第一个结果,也就是下载次数最多的那个插件,点击 Install 进行安装(网速正常的话,安装速度非常快)
然后 ,点击 Restart IDEA 重启 IDEA 工具(一定要重启 IDEA 哟,不重启的话不会生效)
最后 ,重启 IDEA 之后,可以在 IDEA 工具最右侧栏看到一个蓝色图标并带有 RestServices 字样,可以点击 RestServices 字样展开,这样就表示安装 RestfulToolKit 插件成功,下面就可以使用它了!
3. 使用 RestfulToolKit 测试接口
安装完成之后,我们便可以选择一个 Project 并打开它,看看 RestfulToolKit 的强大之处了。
1. 接口统计分析:我这里打开一个已有的 Project 之后,插件会自动检测出该 Project 下的四个模块总共有 277 Restful 接口,它可以帮我们统计 Restful 接口数量。
2. 全局模糊匹配:通过选中父工程,然后直接输入接口名,这样便可以在全局范围内模糊匹配你搜索的接口并实时显示模糊匹配的结果(不限于你当前打开的模块进行搜索)。
3. 局部模糊匹配:既然能够在全局范围模糊匹配搜索的接口,那么自然也可以在具体的子模块下进行搜索接口啦,只需要选中具体子模块,然后输入接口名便可以实时显示模糊匹配的结果。
4. 自动填入请求方式和地址 :当你找到需要测试的接口方法,点击得到的方法名,便会自动地填充接口方法的请求方式和访问地址,并且还能生成请求数据示例 !,点击右侧的 send 按钮便可以发起调用了。
5. 自动生成数据示例 :下图当中框起来的 appId: 1
便是自动生成的数据示例,RequestParams 下方可以传入 JSON 格式的指定参数,RequestBody 下方可以看到调用接口返回的结果,大家可以自行实验,这里不再演示了。
6. 快速定位接口所在代码文件 :RestfulToolKit 插件还有一个快捷键搜索功能,使用快捷键 Ctrl+\
或者 Ctrl+Alt+N
可以模糊匹配搜索的接口方法,定位到该接口方法所在的文件!
4. 总结
RestfulToolKit 插件的安装和使用大概就是这些,至于更多功能可以自己摸索(其实基本已经介绍的差不多了)。
最后想说的是,使用它并不是为了达到取代 Postman 或者 Apifox 这样专业的测试工具的目的,只是在一些应用场景下可能更加地方便而已,它也有缺点,比如返回的数据不能够保存等等。我大部分场景下还是会使用专业的接口测试工具,但是偶尔测试一些简单的接口用插件还是很香的,大家也可以根据自己的需求来吧!