一款专为IntelliJ IDEA用户设计的插件,极大简化Spring项目中的API调试过程,功能强大(附源码)

news2024/9/20 12:02:10

前言

在软件开发过程中,尤其是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扫描方式:Static 和 Dynamic,快速识别项目中的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 {
    @Bean
    public 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/

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2051754.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

python 捕获异常

捕获指定异常 e 是保存的异常信息 捕获多个异常

快速体验fastllm安装部署并支持AMD ROCm推理加速

序言 fastllm是纯c实现,无第三方依赖的高性能大模型推理库。 本文以国产海光DCU为例,在AMD ROCm平台下编译部署fastllm以实现LLMs模型推理加速。 测试平台:曙光超算互联网平台SCNet GPU/DCU:异构加速卡AI 显存64GB PCIE&#…

Selenium + Python 自动化测试18(数据驱动实现测试)

我们的目标是:按照这一套资料学习下来,大家可以独立完成自动化测试的任务。 上一篇我们讨论了数据驱动测试中如何读取Excel文件,今天我们试着进一步深入学习数据驱动。 本篇文章我们讨论一下如何使用数据驱动思想实现测试。 1、数据驱动框架…

从零开始学cv-5: 图像的仿射变换

文章目录 一,简介:二,图像仿射变换详解2.1,图像平移:2.2 ,图像旋转:2.3,仿射变换: 一,简介: 仿射变换(Affine Transformation 或 Aff…

Lumina学术引擎免费问世,性能超谷歌学术5倍

Lumina介绍 Lumina是一款完全免费的AI学术搜索引擎,借助强大的数据库和高效的匹配速度。利用超过 15 种模型从超过 100 万篇期刊文章中找出最相关的来源,从而构建答案。搜索结果相关性平均比谷歌学术高出5倍,支持超1亿研究对象搜索&#xff…

8.18日学习打卡---Spring Cloud Alibaba(五)

8.18日学习打卡 目录: 8.18日学习打卡 RocketMQ什么是RocketMQ生产者和消费者技术架构 RocketMQ安装与配置环境搭建与测试RocketMQ管理命令 RocketMQ发送消息普通消息顺序消息之全局消息顺序消息之局部消息消费者消费消息延迟消息延迟消息代码实现单向消息批量消息过…

【HarmonyOS】云开发-用户自动认证

背景 华为云服务提供了统一认证的云服务,支持手机、邮箱等自定义登录服务,并且提供了免费使用的额度,这样子方便中小企业或者项目快速的开发工作。下面是支持的认证方式: 操作步骤 1.AGC(AppGallery Connect)创建项目 在AGC界…

C++ | Leetcode C++题解之第342题4的幂

题目: 题解: class Solution { public:bool isPowerOfFour(int n) {return n > 0 && (n & (n - 1)) 0 && n % 3 1;} };

zabbix监控进程、日志、主从状态和主从延迟

zabbix监控进程、日志、主从状态和主从延迟 监控进程1、下载服务2、编写脚本3、编写zabbix_agentd.conf4、新建监控项配置触发器5、查看邮件 监控日志1、上传log.py的2、编写zabbix_agentd.conf3、新建监控项配置触发器 监控数据库主从状态1、编写/etc/hosts(master…

IOS 09 R.swift框架和使用方法

R.swift框架主要是实现通过类字段访问字符串,图片,等资源;类似Android那边通过R类访问,好处是有提示,如果缺少资源,直接就是编译错误;OC类似的功能叫R.objc。 添加依赖 添加依赖 #将资源&…

第八周:机器学习笔记

第八周机器学习笔记 摘要Abstract机器学习1. 鱼和熊掌和可兼得的机器学习1.1 Deep network v.s. Fat network 2. 为什么用来验证集结果还是不好? Pytorch学习1. 卷积层代码实战2. 最大池化层代码实战3. 非线性激活层代码实战 总结 摘要 本周学习对李宏毅机器学习视…

AI学习记录 - Word2Vec 超详细解析

创作不易,点个赞 我们有一堆文本,词汇拆分 sentences ["jack like dog", "jack like cat", "jack like animal","dog cat animal", "banana apple cat dog like", "dog fish milk like"…

URP平面阴影合批处理 shadow

闲谈 相信大家在日常工作中发现了一个问题 , urp下虽然可以做到3个Pass 去写我们想要的效果,但是,不能合批(不能合批,那不是我们CPU要干冒烟~!) 好家伙,熊猫老师的偏方来了 &#x…

【数值方法-Python实现】Crout分解+追赶法实现

涉及Crout分解、追赶法的线性方程组求解方法的Python实现。 原文链接:https://www.cnblogs.com/aksoam/p/18366119 Codes def CroutLU(A:np.ndarray)->Tuple[np.ndarray,np.ndarray]:"""Crout LU分解算法,ALUinput:A: (n,n) np.ndarray,方阵out…

DrissionPage自动化获取城市数据内容

一、获取页面内容 二、最终结果 上海市 约收录140个指标 查看98075次 人均GDP 153299元 公交车 17899辆 户籍人口 1469.3万人 三、代码 from DrissionPage._pages.chromium_page import ChromiumPage import time page ChromiumPage() page.get(https://www.swguancha.com/…

【Delphi】中多显示器操作基本知识点

提要: 目前随着计算机的发展,4K显示器已经逐步在普及,笔记本的显示器分辨率也都已经超过2K,多显示器更是普及速度很快。本文介绍下Delphi中操作多显示器的基本知识点(Windows系统),这些知识点在…

UniFab 是一款由人工智慧驅動的視訊增強器+ crack

UniFab 是一款功能强大的视频处理工具,包括 10 个基于 AI 的功能。使用 UniFab,您可以提高视频和音频质量、将视频转换为不同的格式、根据自己的喜好编辑视频等等。以下是适用于 Windows 的 UniFab 程序的简要说明: 视频转换器。UniFab 支持 1000 多种视频格式的转换,包括 …

构建自己的图数据集

代码: import warnings warnings.filterwarnings("ignore") import torch from torch_geometric.data import Datax torch.tensor([[2,1],[5,6],[3,7],[12,0]],dtypetorch.float) y torch.tensor([0,1,0,1],dtypetorch.float)#定义边 edge_index torc…

⌈ 传知代码 ⌋ DETR[端到端目标检测]

💛前情提要💛 本文是传知代码平台中的相关前沿知识与技术的分享~ 接下来我们即将进入一个全新的空间,对技术有一个全新的视角~ 本文所涉及所有资源均在传知代码平台可获取 以下的内容一定会让你对AI 赋能时代有一个颠覆性的认识哦&#x…

Leetcode3232. 判断是否可以赢得数字游戏

Every day a Leetcode 题目来源:3232. 判断是否可以赢得数字游戏 解法1:3232. 判断是否可以赢得数字游戏 用一个 sum1 统计个位数的和,sum2 统计十位数的和。 只要 sum1 和 sum2 不相等,Alice 拿大的就能赢得这场游戏。 代码…