Fast Request 是一个基于springmvc、springboot的帮助你快速生成url和参数的IDEA插件。同时也是一个http client工具,你只需要按一下方法左侧的小图标(小火箭),插件就会帮你生成方法的url和参数显示在工具内,再点击发送请求即可在IDEA内完成API调试,并且可以保存历史请求,方便再次使用调试。
- 其他插件:IDEA日志转sql语句插件 Mybatis Log Plus 的安装配置与使用
- 其他插件:IDEA建造者代码生成插件 InnerBuilder 的安装配置与使用
- Restful Fast Request官网:https://dromara.org/fast-request/
1、安装方式
1.1 在线安装方式
第一种方式,是在IDEA上搜索插件进行安装,会适配当前IDEA的版本。打开File -> Settings 界面(或者使用快捷键Ctrl+Alt+S进入到Settings设置页面),在左侧列表中找到 Plugins 菜单,在右侧的 Marketplace 页签下,搜索 “Fast Request”,可以找到 Restful Fast Request 插件,如下图所示,点击 Install 进行安装即可。
该插件为付费插件,但是有30天的试用期(介绍中可以看到)。
1.2 离线安装方式
第二种安装方式是使用离线插件进行安装。插件下载页面:https://plugins.jetbrains.com/idea ,在搜索框中输入插件名称 “Restful Fast Request” 搜索,点击出现的下拉提示,即可进入插件下载页面,选择对应安装版本下载即可。
下载完成后,进入插件市场,选择本地安装
同样是在 Settings 界面,在左侧列表中找到 Plugins 菜单,在右侧的 Installed 页签右方有个齿轮图标,点击展开菜单后选择 “Install Plugin from Disk…”,此时会打开本地文件选择框,选择你下载的插件包安装即可。
安装完成后会提示重启,重启idea后该插件就可以正常使用了。
2、插件的禁用或卸载
打开File -> Settings 界面(或者使用快捷键Ctrl+Alt+S进入),在左侧列表中找到 Plugins 菜单,在右侧的 Installed 页签下,选中需要卸载的插件如 Database Navigator, 在插件列表每个插件的右侧有个复选框,勾选表示启用插件,去掉勾选为禁用插件。在列表右侧的详情页右上角有个齿轮图标,点击后出现下拉菜单,其中Disable表示禁用(如果当前插件是禁用状态则这里的文字为Enable表示启用),Uninstall表示卸载插件。
3、插件的功能
对比与HTTP Client,Fast Request不仅拥有HTTP Client内置的功能,还提供了友好易懂直观的界面,让使用者调试API的时候能够更加方便、简捷,同时各种类型参数也提供了不同的定制方式,更加灵活。
- API导航树
- SearchEveryWhere搜索API
- API导出到Postman
- 一键生成url和参数
- 发送请求调试API(支持修改生成的参数)
- 域名定制及切换
- 自定义参数解析
- 字符串生成策略化
- 保存API
- 管理API(搜索过滤、修改API名称)
- 一键定位历史保存的API到方法
- API转curl
- 自动将API关联到模块分组
- 内置Json参数编辑器
4、插件的使用
4.1 创建项目和环境
点击 IDEA 右侧的 FastRequest 按钮即可打开该插件面板,第一次使用需要先配置项目名和环境名;
点击管理配置按钮进行配置,配置好项目名,还有环境名,这里配置了dev和test两个环境的访问地址;
填写好dev和test的地址
如果有全局请求头,可以在该页面统一设置
选择好项目名和环境后就可以开始调试API接口了。
动态演示效果如下:
4.2 调试API接口
点击接口左侧的小火箭按钮即可直接生成调用接口所需的信息,修改好参数之后就可以直接调用了;第一次使用的时候需要先同意协议。
- 新版本中发送按钮在工具栏,左侧图标从火箭变为了R图标。
点击小飞机按钮发送请求,可以接收到格式化好的JSON数据。
动态演示效果如下:
4.3 终止 API 请求功能
4.4 快速添加Header
如果你的请求需要一个 token 而 token 可以通过一个登陆接口得到,那么你可以不用每次手动添加,只需要访问一下登录接口再通过以下操作来处理。版本要求: 2.0.0
4.5 Headers 分组
场景:SpringBoot等多模块项目不同项目、不同环境下头参数不同,为了快速自动切换headers,引入了header分组
操作方式:
- 在headers group里修改约束:输入的值必须是标准json格式
- 直接切换环境,然后再headers表格中输入对应的key、value值
4.6 Json 语法检查
右上角提供了 json 语法检查如果输入有误会提示对应的错误,当然也支持格式化等操作。版本要求: 2.0.6
4.7 SearchEveryWhere
全局搜索功能,输入案例
/url (查询指定url)
get /list (指定get方式指定url)
post /save (指定post方式指定url)
方法关键字 (查询指定描述)
4.8 项目级别全局参数支持
支持项目级别内的全局参数,不受多模块影响。配置优先级api头 > 项目级别全局请求头 > 全局请求头
4.9 当前方法定位
当你生成好方法的 url 以后又切换到代码中的别的地方然后又想开始调试该 API 方法可以通过此功能快速定位到代码
4.10 下载文件
点击 Send and download
4.11 保存请求
- 保存的请求默认会放入Default Group中,支持拉拽放入别的组,当然最好是加入 module 分组,请查看 api 分组自动关联
- API 取名:如果 api 使用了 swagger 注解 @ApiOperation(“xxx”),则 api 取名 xxx,如果没加 swagger 注解,则使用 javadoc 作为 api 的名称,否则将取名 New Request
if (@ApiOperation("xxx"))
apiName = xxx
else if(java doc)
apiName = java doc
else
apiName = New Request
4.12 API 分组
目的是一个 API 下保存不同组合的参数,在输入参数后点击分组请求保存,原保存操作将默认归类到 Default 分组
切换参数操作,以下是 book 列表 3 种语言的查询
4.13 临时请求保存支持
目的:项目中保存任意不属于本项目的请求,用于临时调用,跟当前项目代码不关联。临时请求保存的 Request 的 Url 必须以 http 或者 https 开头
4.14 重新生成请求
如果你已经保存一个请求,但是想彻底重新修改其中的参数,那么你可以选择该操作
4.15 cURL 导入
请注意如果需要绑定方法,则需要将光标放置到方法名上
4.16 CURL 拷贝
必须是先生成方法 url 及参数后,点击工具栏图标
4.17 一键拷贝 Url
4.18 API 文档同步
用于将 API 文档同步至 Github、 Gitee、 Gitlab, 生成在线文档,分享给其他的小伙伴看。
注意:
- 内网无网络情况下请用私有域名 gitlab,gitlab 只支持 v4 不支持其他版本,不行考虑升级
- 如果配置后的仓库在云端不存在,则默认创建私有的仓库
- 项目访问 404 了,解决办法是分享的时候需要将仓库设置为 public 或者将小伙伴拉至仓库成为某一个成员
- 一个项目对应同步一个仓库,确定好一个仓库并且同步了一部分文档以后,不要再在后面切换修改仓库,历史记录无法同步
该功能配置:
4.19 历史请求预览
隐藏技能:双击记录可以展示详情
4.20 API 列表
API 列表 name 取值:
- 如果方法使用了 swagger 的 @io.swagger.annotations.ApiOperation ,则取该注解的 value 值
- 如果没有 swagger 直接修饰,则取方法的 javaDoc 描述
- 如果以上都没有则返回 New Request
- API 的 name 值支持修改。
4.21 API 导出到 Postman
4.22 APIs 导入导出
利用该功能,你可以非常方便得将自己已有的 APIs 分享给别的开发者,或者导入到其他设备上的 IDEA。注意点:
- 导出的时候会新增一个名为 fastRequestCollection.xml 的 xml 文件,你不能重命名它, 默认导出到当前项目路径下。
- 导入的时候会做默认备份,并且会在.idea 文件夹下生成一个名为 fastRequestCollection-yyyyMMddHHmmssSSS.xml 的文件, 如果是导入误操作,可以通过导入它来还原。
- 如果 fastRequestCollection.xml 不可见,点击 file->Reload All from Disk 来强制刷新。
4.23 批量导出 API 文档
选中对应的文件夹,即可导出文件夹下的所有 API。
4.24 API 导航树
选中树输入关键字,再按回车或者鼠标左键双击即可定位到 API。悬浮鼠标显示 api 的 doc。API Navigate 树需要点击刷新按钮,同样每次新增了 API 你也需要刷新才能得到
4.25 API 一览表预览
聚焦窗口后输入关键字,根据 API 的路径关键字可以快速搜索。
评论区