一款提升开发效率的工具,专为IntelliJ IDEA用户设计的插件,解决API调试调用痛点,高效率很强大(附源码)

本文主要是介绍一款提升开发效率的工具,专为IntelliJ IDEA用户设计的插件,解决API调试调用痛点,高效率很强大(附源码),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

在软件开发过程中,尤其是Spring MVC(Boot)项目中,API调试调用是一项常见但繁琐的任务。现有的开发工具虽然提供了一些支持,但往往存在效率不高、操作复杂等问题。为了处理这些痛点,提升开发效率,一款新的工具应运而生。

图片

介绍

Cool Request是一款专为IntelliJ IDEA用户设计的插件,它极大地简化了Spring项目中的API调试过程。这款插件具备以下特点:

  • 强大的参数推测能力:自动推算API所需的各种参数,包括URL、Header、JSON和表单参数。

  • 运行时反射调用:允许用户绕过拦-截器,直接进入Controller方法,进行调试。

  • 手动触发定时器:提供了手动触发SpringBoot中的定时任务的能力。

  • 一键导出openapi格式:方便API文档的生成和共享。

  • 一键导入到apifox:支持将API导入到apifox平台,支持目录选择。

  • 复制请求为curl:快速复制API请求为curl命令,方便在其他环境中使用。

  • 前置/后置脚本处理:使用Java语法处理请求前后的逻辑。

  • 响应结果保存:一键保存HTTP响应结果到文件。

  • 多种响应格式预览:支持JSON、XML、图片、HTML和文本的快速预览。

  • 静态资源服务器:快速配置静态资源服务器,便于文件共享。

图片

技术架构

Cool Request基于IntelliJ IDEA插件架构开发,利用了IDEA提供的API和扩展点,实现了与Spring MVC(Boot)项目的无缝集成。

部署方式

Cool Request的安装非常简单,用户可以通过以下两种方式之一进行安装:

  1. 离线安装:下载插件的离线包,然后在IDEA的Settings > Plugins > Install Plugin From Disk中选择下载的文件进行安装。

  2. 在线安装:在IDEA的Settings > Plugins搜索Cool Request,然后安装。

开源协议

Cool Request遵循GPL2.0开源协议。

即刻体验一波

Cool Request的使用教程提供了详细的指导,帮助用户快速掌握插件的使用。从扫描API、发起HTTP和反射请求,到环境配置、Spring网关自动发现、手动触发定时器,再到创建静态服务和导入cURL参数,Cool Request都提供了直观的cao作界面和简便的cao作流程。

特色功能

开启耗时追踪

Cool Request默认关闭方法耗时追踪,如果开启后,会影响发起API时的速度,如果不需要耗时追踪,可关闭

图片

当正常发起HTTP请求时,Cool Request将分析一次目标方法,根据设置的深度,尽可能多的追踪方法,这需要花费一些时间,且视所设置深度为定。

图片

如果自动分析无法满足需求,可在任意方法体内右击,选择Cool Request -> Add/Cancel Method To Trace,添加/取消目标方法。

图片

自定义函数

Cool Request拥有强大得函数支持系统,当HTTP参数想要使用动态参数时,可根据自己需求,编写自定义函数。函数可使用在任意HTTP参数中,包括请求头、URL参数、Path变量、请求体中。

图片

例如想要增加一个自定义函数,可编写以下代码。

public String custom(){return "custom";
}

在任意HTTP参数值中,通过{{函数名}}来引用此函数。

图片

关闭函数转换 如果想关闭函数转换,可以设置中禁用

图片

Cool Request支持在SpringBoot运行时调用任意容器内实例的方法、同时也包括静态方法。

调用任意方法

在想要调用的方法体内右击,选择CoolRequest->Call this Method

图片

接着运行按钮即可。

图片

当然,Cool Request支持大量常见的参数传递

图片

图片

快速扫描API

Cool Request提供两种API扫描方式:StaticDynamic,快速识别项目中的API端点。(1)Static扫描会尽可能多的扫描出API,但不会扫描第三方库中的数据,在IDEA 建立索引完成后自动触发一次Static扫描。(2)Dynamic仅在项目启动后有效,原理是从SpringBoot容器中获取数据,此方法获取的数据最全。动态扫描在项目启动后会自动刷新一次。

图片

快速做API搜索

通过API路径快速搜索对应的Controller,插件提供两种方法唤起搜索界面。

  1. 顶部搜索图标

图片

  1. 快捷键

Windows/Linux:Ctrl+Shift+N Mac: Cmd + Shift + O 选中Cool Request页来进行API搜索

图片

  1. 快捷键 默认为Ctrl+Shift+S

可在设置中进行更改

图片

可以建立多套环境配置

Cool Request提供了环境配置,可以配置不同参数、如URL主机、全局参数、全局请求头、全局x-www-form-urlencoded、全局form-data。

图片

+号,输入环境名称、主机路径,"OK"即可增加新的环境,用户可通过不同环境,自行增加全局参数。

图片

发起HTTP请求调试

扫描API成功后,任意API进行调试,Cool Request将发起HTTP请求。当扫描API成功后,双击将要调试的API。

图片

会自动跳转到HTTP请求界面。

图片

发起反射请求

选择使用反射调用,直接进入目标Controller方法,绕过HTTP请求创建。发射请求可绕过系统中的拦-截器,在开发时,可直接使请求进入到Controller方法。普通HTTP请求的流程如下:

  1. 构造HTTP参数

  2. 发起HTTP请求

  3. 进入Web容器

  4. 进入过滤器

  5. 进入拦-截器

  6. 进入Controller

而反射请求可以跳过其中的第3、第4步骤,而第5步是可选的,反射的流程如下:

  1. 构造HTTP参数

  2. 发起HTTP请求

  3. 进入拦-截器(可选择是否应用拦-截器)

  4. 进入Controller

进入参数配置界面,在左侧下拉框选中如下所示:

图片

右侧 按钮即可发起反射请求。

Spring网关自动发现

网关程序启动后,自动提取配置路径并添加到环境变量中。Cool Request在网关程序启动后,会自动提取网关配置的路径,并添加到环境变量中,用户只需要根据实际修改配置即可。例如有以下代码:

@Configuration
public class Config {@Beanpublic RouteLocator customRouteLocator(RouteLocatorBuilder builder) {return builder.routes().route("apiroute", r -> r.path("/api/**").filters(f -> f.stripPrefix(1)).uri("http://localhost:8080")).build();}
}

启动成功环境设置,可以发现会有一个名为apiroute的环境。

手动触发@Scheduled定时器

特色功能,手动触发具有@Scheduled注解的方法,无需等待Spring自动调度。手动触发定时器是Cool Request特色功能之一,他可以在运行时候,调用任意具有@Scheduled注解的方法,这样带来的好处是无需等待Spring自动调度,省去了开发人员调试定时器带来的麻烦。等项目启动后,在列表中选择要触发的函数名称。

图片

双击方法进入调用界面,其中按钮即可发起调用。

图片

手动触发定时器是Cool Request特色功能之一,他可以在运行时候,调用任意具有@XxlJob注解的方法,这样带来的好处是无需等待XXL-JOB自动调度,省去了开发人员调试定时器带来的麻烦。

手动触发XXL-JOB定时器

等项目启动后,在列表中选择要触发的函数名称。

图片

双击方法进入调用界面,其中按钮并填写参数即可发起调用。

创建静态服务

快速配置静态资源服务器,便于本机数据共享。(1)进入静态服务器页面,+号。

图片

(2)要共享的文件夹,选择监听的端口后,并左侧开关按钮,即可开启静态web服务。

图片

(3)访问浏览器,输入对应文件名,即可下载/预览相关联的文件。

图片

导入cURL参数

快速导入cURL命令中的参数,简化开发人员cao作。(1)参数界面中的cURL图标,选择Import cURL。

图片

(2)填写cURL数据,并OK。通过Cool Request插件,用户可以享受到直观的cao作界面和简便的cao作流程,极大提升开发和调试API的效率。

结语

Cool Request作为一款提升开发效率的工具,以其强大的功能和易用性,为Spring MVC(Boot)项目的开发人员提供了极大的便利,相信将成为开发过程中不可或缺的助手。

源码地址:https://github.com/CorentinTh/it-tools
体验文档:https://it-tools.tech/

这篇关于一款提升开发效率的工具,专为IntelliJ IDEA用户设计的插件,解决API调试调用痛点,高效率很强大(附源码)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1117482

相关文章

基于C++的UDP网络通信系统设计与实现详解

《基于C++的UDP网络通信系统设计与实现详解》在网络编程领域,UDP作为一种无连接的传输层协议,以其高效、低延迟的特性在实时性要求高的应用场景中占据重要地位,下面我们就来看看如何从零开始构建一个完整... 目录前言一、UDP服务器UdpServer.hpp1.1 基本框架设计1.2 初始化函数Init详解

Django调用外部Python程序的完整项目实战

《Django调用外部Python程序的完整项目实战》Django是一个强大的PythonWeb框架,它的设计理念简洁优雅,:本文主要介绍Django调用外部Python程序的完整项目实战,文中通... 目录一、为什么 Django 需要调用外部 python 程序二、三种常见的调用方式方式 1:直接 im

SpringBoo WebFlux+MongoDB实现非阻塞API过程

《SpringBooWebFlux+MongoDB实现非阻塞API过程》本文介绍了如何使用SpringBootWebFlux和MongoDB实现非阻塞API,通过响应式编程提高系统的吞吐量和响应性能... 目录一、引言二、响应式编程基础2.1 响应式编程概念2.2 响应式编程的优势2.3 响应式编程相关技术

JAVA Calendar设置上个月时,日期不存在或错误提示问题及解决

《JAVACalendar设置上个月时,日期不存在或错误提示问题及解决》在使用Java的Calendar类设置上个月的日期时,如果遇到不存在的日期(如4月31日),默认会自动调整到下个月的相应日期(... 目录Java Calendar设置上个月时,日期不存在或错误提示java进行日期计算时如果出现不存在的

Nginx错误拦截转发 error_page的问题解决

《Nginx错误拦截转发error_page的问题解决》Nginx通过配置错误页面和请求处理机制,可以在请求失败时展示自定义错误页面,提升用户体验,下面就来介绍一下Nginx错误拦截转发error_... 目录1. 准备自定义错误页面2. 配置 Nginx 错误页面基础配置示例:3. 关键配置说明4. 生效

python版本切换工具pyenv的安装及用法

《python版本切换工具pyenv的安装及用法》Pyenv是管理Python版本的最佳工具之一,特别适合开发者和需要切换多个Python版本的用户,:本文主要介绍python版本切换工具pyen... 目录Pyenv 是什么?安装 Pyenv(MACOS)使用 Homebrew:配置 shell(zsh

java中4种API参数传递方式统一说明

《java中4种API参数传递方式统一说明》在Java中,我们可以使用不同的方式来传递参数给方法或函数,:本文主要介绍java中4种API参数传递方式的相关资料,文中通过代码介绍的非常详细,需要的... 目录1. 概述2. 参数传递方式分类2.1 Query Parameters(查询参数)2.2 Path

VSCode开发中有哪些好用的插件和快捷键

《VSCode开发中有哪些好用的插件和快捷键》作为全球最受欢迎的编程工具,VSCode的快捷键体系是提升开发效率的核心密码,:本文主要介绍VSCode开发中有哪些好用的插件和快捷键的相关资料,文中... 目录前言1、vscode插件1.1 Live-server1.2 Auto Rename Tag1.3

Java调用DeepSeek API的8个高频坑与解决方法

《Java调用DeepSeekAPI的8个高频坑与解决方法》现在大模型开发特别火,DeepSeek因为中文理解好、反应快、还便宜,不少Java开发者都用它,本文整理了最常踩的8个坑,希望对... 目录引言一、坑 1:Token 过期未处理,鉴权异常引发服务中断问题本质典型错误代码解决方案:实现 Token

springboot3.x使用@NacosValue无法获取配置信息的解决过程

《springboot3.x使用@NacosValue无法获取配置信息的解决过程》在SpringBoot3.x中升级Nacos依赖后,使用@NacosValue无法动态获取配置,通过引入SpringC... 目录一、python问题描述二、解决方案总结一、问题描述springboot从2android.x