目前SpringBoot系列框架非常流行,大多数开发都是基于前后端分离的模式进行开发,这种过程中势必会涉及到大批量的API调试,到目前为止,IntelliJ IDEA是Java软件开发最多使用的开发工具,最近我在IntelliJ IDEA插件市场下找到了一块非常好用的插件Restful Fast Request,细节非常到位,说它是IDEA版的Postman也不为过,推荐给大家!
什么是Restful Fast Request
Restful Fast Request 是idea版Postman。它是一个强大的restful api工具包插件,可以根据已有的方法帮助您快速生成url和params。Restful Fast Request = API调试工具 + API管理工具 + API搜索工具
。它有一个像Postman一样界面来完成请求、检查服务器响应、存储你的api请求和导出api请求。插件帮助你在IDEA界面内更快更高效地调试你的API
支持的框架
Spring 体系 (Spring MVC / Spring Boot)
Kotlin (Spring MVC / Spring Boot)
JAX-RS
安装
- 方式1(推荐): IDEA插件市场搜索Restful Fast Request
- 方式2:
https://plugins.jetbrains.com/plugin/16988-restful-fast-request
配置
基础配置
刚开始使用需要配置项目名[例如card]、环境名[例如local、dev],然后配置对应的域名
String生成配置
可以使得生成出来的字符串随机动态
策略
* name+random(字段名加随机字符串)
* random(随机字符串)
* none(不生成)
类型映射配置
参考
https://dromara.gitee.io/fast-request/guide/getstarted/dataMapping.html
使用
调试API
点击接口左侧的小火箭
按钮即可直接生成调用接口所需的信息,点击绿色的Send按钮即可发送请求
下载文件
点击蓝色图标Send and Download
保存API
点击生成完参数,并进行适量修改后,可以对该API进行保存,方便后续再次调试的时候使用
SearchEveryWhere支持
通过SearchEveryWhere可以快速搜索对应的API,可以通过url关键字、请求方式+url关键字、方法描述来搜索API
快速添加Token到Header
发送请求后可以通过response
中的Json
页签,选中字段,点击添加,将token快速添加到了项目级别的头参数中,极大地节省了手动复制操纵的行为。
API导出到Postman
可以将已经保存的API导出到postman,非常方便
APIs列表
展示了保存的API,同时也可以进行各种不同策略的搜索,点击右侧的定位图标可以快速定位到对应的代码
,也可以直接点击发送按钮,对保存的API发起请求
API导入导出
可以将保存的API导入及导出,跟不同的开发之间分享
Curl拷贝
点击小火箭生成完参数后,可以通过点击curl图标快速生成对应api的crul
Swagger默认值解析支持
支持swagger2、swagger3默认值解析
支持的注解
swagger2
* @ApiParam
@GetMapping(value="/test/{id}")
public String test3(@ApiParam(name = "id",example="2") @PathVariable("id") Integer id) {
return "";
}
@GetMapping(value="/test/{id}")
public String test3(@ApiParam(name = "id",defaultValue="2") @PathVariable("id") Integer id) {
return "";
}
* @ApiImplicitParam
@ApiImplicitParams({
@ApiImplicitParam(paramType="query",name="pageNo",dataType="String",required=true,value="pageNo",defaultValue="1"),
@ApiImplicitParam(paramType="query",name="pageSize",dataType="String",required=true,value="pageSize",defaultValue="10")
})
@GetMapping(value="/testPage)
public String testPage(@RequestParam("pageNo") Integer pageNo, @RequestParam("pageSize") Integer pageSize) {
return "";
}
* @ApiModelProperty
@Data
public class UserDto {
@ApiModelProperty(example = "Bob")
private String userName;
}
swagger3
* @Parameter
@GetMapping(value="/test/{id}")
public String test3(@Parameter(name = "id",example="2") @PathVariable("id") Integer id) {
return "";
}
* @Schema(swagger3)
@Data
public class UserDto {
@Schema(example = "Bob")
private String userName;
}
API自动生成注释
字段注释需要符合标准注释规范,使用/*描述/
可以通过点击隐藏或显示Description
API生成Markdown文档
当我们在开发API的时候,例如在跟第三方对接接口的时候往往需要API文档,那么可以通过该功能快速导出API对应的文档
API预览
API预览可以快速预览当前Controller下的API,并且可以快速定位代码。聚焦窗口后输入关键字,根据API的路径关键字可以快速搜索
项目全局参数
可以进行配置,设置项目级别下的Headers、Url Params、Url-Encoded Params、Cookie等全局参数
自动Cookie存储
当一些需要cookie支持的项目,当发送完请求后,插件会自动地将Cookie放入项目级别参数Cookie中,后续需要Cookie的请求就可以使用该Cookie了
历史请求预览
该功能可以让我们查阅历史请求的API以及对于的参数、url等信息
Html预览
可以对html形式的响应在IDEA内进行预览
总结
Restful Fast Request这个插件,体验确实不错。深入体验,确实能发现很多惊喜,并且提供了免费版和收费版,收费版中又做了很多细致化的功能,提升了很大的生产力,而且加入技术群直接打6折,确实值得入手一把
Restful Fast Request,最好用的IDEA API调试插件