几个测试接口的好工具,效率加倍~

news2025/1/21 6:29:37

作为一名后端程序员,一定要对自己写的接口负责,保证接口的正确和稳定性。因此,接口测试也是后端开发中的关键环节。

但我相信,很多朋友是懒得测试接口的,觉得这很麻烦。一般自己写的接口自己都不调用,而是直接甩给前端或者其他调用方去验证,出了问题再改。虽然自己爽了,但在别人眼里,可能已经对你 “怀恨在心”,不是不报,时候未到而已。

其实测试接口并不难,这篇文章就给大家分享一些常用的接口测试工具,其中有些工具不仅能帮助你高效测试接口,甚至还能自动生成接口代码和接口文档!

常用接口测试工具

这里给大家推荐 4 种常用的接口测试工具,至于到底用哪个,全凭大家的喜好,自己用着舒服就好。

1、cURL

cURL 是一个功能强大的命令行工具,它可以用命令的形式来发送各种类型的 HTTP 请求。虽然它没有图形界面,但是却非常灵活,深受开发者们的喜爱。

指路:https://curl.se/

cURL 的用法也很简单,比如测试 GET 请求类型的接口,只需输入下列命令:

curl <要测试的接口地址>

测试 POST 类型的接口,命令如下:

curl -d '{"name":"yupi"}'
  -H "Content-Type: application/json"
  <要测试的接口地址>

其中使用 -d 选项表示要发送的数据,-H 选项设置请求头,指定发送 JSON 数据。

以上只是 cURL 的基础用法,它还支持很多高级的参数,不过没必要去记忆。一般我们在调用别人接口时,可以先在 F12 开发者工具中找到某个请求,然后点击 以 cURL 格式复制 就能得到可直接使用的 curl 命令了。

强烈建议大家学会使用 cURL,尤其是 Linux 开发者们,在没有图形界面的场景下这个工具可太实用了。

2、Apifox

要是几年前,我可能还会建议大家去用 Postman 这种图形界面测试软件,但现在时代变了,越来越多国产的接口测试工具能力已经远超了 Postman。

比如我在用的 Apifox,它是一个非常强大的 API 设计 + 开发 + 测试一体 的协作工具。

指路:http://apifox.com/b2liyupi

首先是支持 20 多种格式的接口数据导入,快速可视化接口信息:

然后可以一键调试接口,哪怕你本地的后端服务器没有启动,也可以通过 Mock 功能快速生成模拟数据!

Apifox 还有个很强大的能力,支持基于接口信息去生成 130 多种语言及框架的代码!也就是说,你可以先和前端约定并编写好接口文档,然后直接生成代码就能给前端调试了。

更多的功能就先不介绍了,感兴趣的同学自己探索。

3、IDEA 的 HTTP Client

IntelliJ IDEA 开发工具内置了一个 HTTP Client 工具,它允许开发者在 IDE 中直接创建、管理和发送 HTTP 请求,并查看响应结果。

用法很简单,首先进入 IDE 的 Tools => HTTP Client,点击创建一个请求:

支持将 cURL 转换为 HTTP 请求,可见 cURL 的地位

然后进入请求编辑界面,刚开始不熟悉请求编写语法的话,可以点击右上角导入示例的请求信息:

比如导入一个 GET 请求示例:

然后点击绿色的箭头就能发送接口测试请求了,能够看到详细的响应信息:

不过我个人不喜欢这种方式来测试接口,写代码已经很累了,结果测试接口还让我写代码???

4、Swagger 和 Knife4j

Swagger

Swagger 是一个知名的 API 开源项目。此前,很多同学对 Swagger 的认识可能仅停留在生成接口文档,即下图的 Swagger UI,可以在线查看和调试接口信息。

指路:https://swagger.io/tools/swagger-ui/

但实际上,Swagger UI 只是 Swagger 的其中一个功能,Swagger 还包含了 Swagger Editor 接口编辑器、Swagger Codegen 代码生成器等强大工具。

严格来说,Swagger 是 一套 完整的 API 开发工具,让我们在统一的界面中完成 API 设计、接口开发、接口测试、文档生成等功能,极大地提高了开发效率。

一般来说,只需要在项目中引入 Swagger 依赖,并且通过注解的方式来描述 API 的信息,就可以使用它进行接口测试和文档生成了。

但其实,我个人已经很久没有直接使用 Swagger 了,而是会选用它的增强版 Knife4j 来生成接口文档。要说原因的话,就是 Swagger 的默认界面有点小丑,API 多了管理起来就会很麻烦。

感受一下:

Knife4j

Knife4j 是一个基于 Swagger 的增强工具,它提供了更美观的界面和更多功能,让接口测试和文档生成更加高效。

指路:https://doc.xiaominfo.com/

Knife4j 的用法很简单,按照官方文档的指引,首先根据自己项目的 Spring Boot 版本引入对应的依赖,比如 Spring Boot 2.x 推荐使用以下 Maven 配置:

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
    <version>4.3.0</version>
</dependency>

然后在 Spring Boot 的配置文件 application.yml 中添加 Knife4j 相关配置,比如:

knife4j:
  enable: true
  openapi:
    title: Knife4j 文档

最后,访问 Knife4j 的文档地址(一般是项目地址 + /doc.html),即可查看自动根据 Controller 接口代码而生成的接口文档。

示例文档如下:

选中某个接口,就可以在线调试了:

当然,因为 Knife4j 的底层也是依赖 Swagger 的,所以你还可以使用 Swagger 注解来自定义接口的信息。

比如下列代码,就使用了 Swagger 的 @Api 和 @ApiOperation 注解给接口添加名称和描述信息:

@RestController
@RequestMapping("/api/posts")
@Api(tags = "帖子管理")
public class PostController {

    @PostMapping
    @ApiOperation(value = "创建帖子", notes = "用于创建新的帖子")
    public ResponseEntity<String> createPost(@RequestBody PostRequest postRequest) {
        // 在这里实现创建帖子的逻辑
        return ResponseEntity.ok("帖子创建成功");
    }
}

这样能让生成的接口文档更通俗易懂,而不是大把的英文。


总结一下,我个人最推荐的接口调试方式是 cURL、Apifox 和 Knife4j 的组合:

  • 无界面(Linux)环境用 cURL
  • 桌面端管理接口、Mock 数据用 Apifox
  • 项目中引入 Knife4j,实现快速的接口文档生成和 web 共享

实践

编程导航星球的所有后端项目都使用了 Swagger + Knife4j 实现接口调试和接口文档生成。

👉🏻 编程导航原创项目教程系列:https://yuyuanweb.feishu.cn/wiki/SePYwTc9tipQiCktw7Uc7kujnCd

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

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

相关文章

【博客系统】 二

本文主要介绍了linux和如何在云服务器上部署一个简单的servlet程序. 一.云服务器 真正搞一个网站,是希望这个网站被其他人访问到 , 所以需要一个云服务器(具有外网ip)来让别人也可以访问 云服务器 操作系统是Linux(一般都是通过命令行来操作) 当前市面上常见的系统: 1.windo…

共享WiFi贴项目商业新模式,到底能不能做

共享WiFi贴的模式&#xff0c;已经在众多商业圈和线下商家门店中引起关注&#xff0c;创造出了一种新的共享互联网商业模式。然而这种共享模式到底能不能做&#xff0c;从中创业者可以获得多少的商业价值呢&#xff1f;让我们一文深度解析一下。 共享WiFi贴&#xff0c;简单来说…

052-第三代软件开发-系统监测

第三代软件开发-系统监测 文章目录 第三代软件开发-系统监测项目介绍系统监测 关键字&#xff1a; Qt、 Qml、 cpu、 内存、memory 项目介绍 欢迎来到我们的 QML & C 项目&#xff01;这个项目结合了 QML&#xff08;Qt Meta-Object Language&#xff09;和 C 的强大功…

智能制造中后期:深挖成本、提升效率的关键——标准工时

在智能制造的背景下&#xff0c;企业面临着持续的成本压力和效率提升的需求。特别是在智能制造的中后期&#xff0c;要想进一步深挖成本、提升效率&#xff0c;必须考虑标准工时这一重要因素。标准工时作为一种基础而富有价值的管理工具&#xff0c;对于建立领先的标准工时系统…

PPP协议_基础知识

ppp协议 点对点协议PPP(Point-to-Point Protocol)是目前使用最广泛的点对点数据链路层协议。 一.ppp协议的组成 PPP协议为在点对点链路传输各种协议数据报提供了一个标准方法&#xff0c;主要由以下三部分构成: 对各种协议数据报的封装方法(封装成帧)链路控制协议LCP    …

【机器学习】 特征工程:特征预处理,归一化、标准化、处理缺失值

特征预处理采用的是特定的统计方法&#xff08;数学方法&#xff09;将数据转化为算法要求的数字 1. 数值型数据 归一化&#xff0c;将原始数据变换到[0,1]之间 标准化&#xff0c;数据转化到均值为0&#xff0c;方差为1的范围内 缺失值&#xff0c;缺失值处理成均值、中…

前后端联调时JS数据精度问题的解决

在JavaScript中&#xff0c;Number类型范围 -2^53 1 到 2^53 - 1&#xff0c;而在Java中Long类型的取值范围是 -2^63 1 到 2^63 - 1, 比JavaScript中大很多&#xff0c;所以后端能正常处理。 其实 ES6 引入了 Number.MAX_SAFE_INTEGER 和 Number.MIN_SAFE_INTEGER 这两个常量…

开源与闭源:驾驭大模型未来的关键决断

在数字化的时代洪流中&#xff0c;开源与闭源的选择不断成为技术界的重要分水岭。随着特斯拉CEO埃隆马斯克的言论及其决策&#xff0c;公开支持开源&#xff0c;并糅合商业理念与技术革新&#xff0c;使得这场辩论再次成为公众关注的焦点。那么&#xff0c;在这场关乎技术发展脉…

八股文-TCP的三次握手

TCP协议是一种面向连接、可靠传输的协议&#xff0c;而建立连接的过程就是著名的三次握手。这个过程保证了通信的双方能够同步信息&#xff0c;确保后续的数据传输是可靠和有序的。本文将深入解析TCP三次握手的步骤及其意义。 漫画TCP的三次握手 TCP连接的建立采用了三次握手的…

vite动态配置svg图标及其他方式集合

文章目录 前言使用vite-plugin-svg-icons动态配置安装插件引入图标下载新建组件svg-icon.vue使用 使用vue组件动态配置总结如有启发&#xff0c;可点赞收藏哟~ 前言 在配置化的情况下&#xff0c;图标配置也显得极为重要的 使用vite-plugin-svg-icons动态配置 参考vite-plugin…

C#中.NET 7.0 Windows窗体应用通过EF访问新建数据库

目录 一、 操作步骤 二、编写EF模型和数据库上下文 三、移植&#xff08;Migrations&#xff09;数据库 四、编写应用程序 五、生成效果 前文已经说过.NET Framework4.8 控制台应用通过EF访问已经建立的和新建的数据库。 前文已经说过.NET 6.0 控制台应用通过EF访问…

【Python大数据笔记_day09_hive函数和调优】

hive函数 函数分类标准[重点] 原生分类标准: 内置函数 和 用户定义函数(UDF,UDAF,UDTF) ​ 分类标准扩大化: 本来&#xff0c;UDF 、UDAF、UDTF这3个标准是针对用户自定义函数分类的&#xff1b; 但是&#xff0c;现在可以将这个分类标准扩大到hive中所有的函数&#xff0c;…

1. redis入门到放弃

使用shutdown命令的时候&#xff0c;会在关机的同时生成一个RDB文件&#xff0c;使数据不丢失。redis虽然有16个库&#xff0c;但是基本上只会用0库&#xff0c;用其他的库没有意义。集群只能在0号库做mysql的读写&#xff0c;大约为写入600笔/s,读2000笔/s 一、Redis全局命令…

本地mysql服务启动后停止,某些服务在未由其他服务或程序使用时将自动停止

背景介绍&#xff1a; MySQL版本5.7&#xff0c;系统Win7&#xff0c;启动mysql服务时提示如下 解决方案 【会删除库中数据及mysql注册信息】&#xff1a; 1、删除原服务MySQL57 C:\Program Files\MySQL\MySQL Server 5.7\bin>mysqld --remove MySQL572、清空data 清空…

elementPlus实现暗黑与白亮主题切换

elementPlus上面默认是支持黑白主题切换的。只需要给html标签添加dark类名并且在mian.ts中导入css变量即可 我们就按照它推荐的useDark这个hook来 useDark使用起来非常简单&#xff0c;只需引入使用即可。vue直接就可以使用&#xff0c;无需做什么其他操作 中文网地址&#…

Apache阿帕奇安装配置

目录 一、下载程序 1. 点击Download 2. 点击Files for Microsoft Windows 3. 点击Apache Lounge 4. 点击httpd-2.4.54-win64-VSI6.zip ​编辑​ 5. 下载压缩包 6.解压到文件夹里 二、配置环境变量 1. 右键我的电脑 - 属性 2. 高级系统设置 3. 点击环境变量 4. 点击系统…

wpf devexpress 自定义统计

总计统计和分组统计包含预定义总计函数。这些函数允许你计算如下&#xff1a; 数据列的数量&#xff08;Count&#xff09; 最大和最小值(Max和Min) 总计和平均值&#xff08;Sum和Average&#xff09; 处理GridControl.CustomSummary 事件或者使用 GridControl.CustomSumm…

2024清理mac苹果电脑内存免费工具CleanMyMac X4.15

当你使用苹果电脑时&#xff0c;内存的优化和清理变得至关重要。随着时间的推移&#xff0c;我们的电脑内存可能会变得拥挤&#xff0c;导致性能下降。清理内存可以提高电脑的速度和反应能力&#xff0c;并确保它始终在良好状态下运行。本文将向您介绍怎么清理苹果电脑内存的方…

深度学习入门(第一天)——深度学习必备知识点

深度学习要解决的问题 人工智能、机器学习、深度学习的区别于联系 机器学习的流程&#xff1a; 数据提取 特征工程 建立模型 评估与应用 特征工程可以说是建模过程中&#xff0c;最重要的部分。 既然特征工程是最重要的&#xff0c;常规我们会做各种各样的特征&#xff0c;…

Google codelab WebGPU入门教程源码<5> - 使用Storage类型对象给着色器传数据(源码)

对应的教程文章: https://codelabs.developers.google.com/your-first-webgpu-app?hlzh-cn#5 对应的源码执行效果: 对应的教程源码: 此处源码和教程本身提供的部分代码可能存在一点差异。运行的时候&#xff0c;点击画面可以切换效果。 class Color4 {r: number;g: numb…