干掉丑陋的swagger,堪称开发者的瑞士军刀!

替代 Postman + Swagger ~Apifox 才是 YYDS 作为一个后端开发者,我做的大部分项目一般都是基于 Swagger 来管理 API 文档,基于 Postman 来做接口调试,基于 JMeter 来做接口性能测试,基于 RAP 等工具 Mock API 数据。 我经常在想:“要不要这么麻烦?有没有一款工具能够直接提供这些功能?经常在不同的工具之间切换来切换去真的很烦呢!”。 我在网上找了很久,终于让我找到了一款游戏 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台 —Apifox。 Apifox 介绍 官方对 Apif. 阅读详情

静态的Swagger们跟不上频繁变更的代码

“为什么改了这个没告诉我”,“实际功能和文档上说的不一样啊”。这些话大家做开发的想必耳朵都听出老茧了。真不是故意的,有时候任务比较急,就先改了代码,想着以后再同步文档,然后就给忘了。项目更新又全靠社交软件通知,人一多难免有一两个没及时沟通到的。确实给合作的小伙伴带来麻烦,但说实话开发也挺委屈的。

这些问题产生的主要原因是,当前大部分研发团队的工作流程是这样的:

8f96f2f4dcaa71685e92afbe2e896199.png
旧协作模式

这种模式带来的问题是:

1.Swagger,postman,MockJS只能完成软件研发流程中某个环节的功能,造成完成接口设计,文档编写,调试,测试验证等工作需要使用好几个工具;

2.更麻烦的是这些工具数据格式不互通,无法互相导入,造成用Swagger定义和编写完成接口后,在Postman,MockJS,Jmeter等工具还要再去手动填写一遍才能开始工作,增加了无意义的工作量。

3.沟通成本总是被忽略不计,但实际上不仅占据了很大时间,各种沟通不及时、沟通不到位还非常让人心累。

4.老板的需求来得急,老板的需求变得快,各种代码修改和变更难以及时通知和同步到团队成员手中。

抱怨当然政治正确,但有啥用,该加的班还是要加。那么有什么办法可以解决这个问题吗?

有的。

换个工具。

低成本做长期主义的事情

我为大家提供的解决方案是一款国内的生产力工具--Apifox。

作为一款研发全流程,接口全周期的生产力工具,这款软件真正完成了数据流的打通,在一个软件上就能实现接口设计--接口文档--接口调试--接口修改--接口mock--接口测试--接口自动化--接口迭代的工作流闭环;

后端,前端,测试各个角色既能各取所需,又能协同合作。

bc5d4cd53790d887713f6d111b01c418.png

Apifox上的协作流程是这样的:

  1. 后端在Apifox可视化接口设计界面上定义好项目各个接口及对应参数同时编写接口文档说明

  2. 前后端一起评审,修改完善接口并在同一界面顺手更新接口文档

  3. 后端使用接口调试功能调试接口

  4. 前端使用零配置高仿真mock功能对前端页面进行调试,无需手写mock规则

  5. 后端使用代码生成功能直接生成接口代码

  6. 测试在接口管理页面一键生成接口参数测试用例,并依据业务场景生成自动化测试用例,一键运行接口用例并生成接口测试报告并分享给相关人员。

  7. 前后端 都开发完,前端从Mock 数据切换到正式数据,进行联调,由于使用同一个接口数据源,且遵循了接口规范,联调顺利

  8. 由于bug修复或需求变更,接口发生了变化,后端修改提交后,前端和测试实时同步到了修改后的数据

  9. 项目经理通过权限设置给研发,产品,测试,外部合作人员分配编辑,只读等各种操作权限,维护了项目安全

  10. 项目经理通过各个接口的状态开发中,测试中,已发布来跟进项目的进度情况,把控项目风险。

Apifox核心功能和界面是这样的:

ed546dd7c5c930c91744f7d12521242e.gif
接口设计
f26140cc210fb46ca038a178af561ccf.gif
接口调试
14f401722100125757393dce84934940.gif
智能mock
9a4f436cf158f2f2c1e18fec72f62379.gif
接口自动化

36氪报道过,Apifox在Pre-A轮融资就得到了3000万元的融资。 资本市场如此看好这个产品的发展潜力,是因为在经济增速变缓的现阶段,

对企业来说,它能通过提高整体的合作效率来为企业节约成本;

对研发人员来说,可以减少无意义的工作量和繁杂耗时的沟通成本,将时间花在能提升自身竞争力的地方。

Apifox>Swagger+Postman+mockJS+Jmeter,它在传统软件的基础上做了不少操作优化和团队协同提效的功能。

Apifox做的增速提效优化

1.接口设计:从代码生成界面到可视化接口设计界面

Apifox 接口文档遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 规范,可生成在线文档;零学习成本即可编写出符合RESTful风格的接口文档,新人上手快;所见即所得,不易出错。

9b3c19ca1b66f5590199be9c95f40a04.png
Swagger通过写代码生成接口页面
cb5a26d869acaf05a534742a6918ec4b.png
Apifox可视化接口设计页面

2.文档维护:从接口与文档分离到接口与文档合并

当你接手旧项目时,发现接口是上周的,接口文档是商周的,上手新项目全靠老司机口口相传,内心大概是崩溃的吧。

接口与文档分离常常导致维护困难。Apifox的接口设计界面提供了Markdown格式的文档说明区,修改完接口就如同commit代码时添加变更说明般,自然而然地形成肌肉记忆。

39d6203f31eed80aa1bb3a210ca3322d.png
接口设计页面提供了接口文档说明区

3.数据复用:从各自为政到定义一次、多次复用

接口数据复用:Swagger,Postman,MockJS,Jmeter等软件彼此之间数据不互通,数据格式不一致,接口导入非常耗时麻烦。

而Apifox能身兼多职,包揽上述软件功能,在Apifox中定义一次接口,能被后端直接用来调试,前端直接用来mock界面,测试直接执行接口自动化。

数据模型复用:可复用的数据结构,定义接口返回数据结构及请求参数数据结构(仅 JSON 和 XML 模式)时可直接引用。

167ec09547bbfa7c8381232ea17aa2d3.png
定义数据模型
7eba3c6ae73191561904d0f4acd098df.png
引用数据模型

4.同步更新,高效沟通:从沟通滞后到数据变更即时同步

当前团队成员之间同步项目信息数据,仍旧依靠着社交软件,低效、不及时,也容易漏掉某些成员。

Apifox为此提供了同步功能,一旦接口数据有更新发生,就会即时同步更新并通知到项目内所有成员。

5118184db19f9896361ed235b02a6ae7.png

5.零配置mock高仿真数据:从苦逼造数据到零配置mock真实数据

Apifox 根据接口定义里的数据结构、数据类型,自动生成 mock 规则。

Apifox 内置智能 mock 规则库,根据字段名、字段数据类型,智能优化自动生成的 mock 规则。

用户还可以自定义规则库,满足各种个性化需求。支持使用 正则表达式、通配符 来匹配字段名自定义 mock 规则。

2fbc923d2403259547a88f1161cb7182.png
内置mock规则,并能自定义规则

除此之外

6.旧有项目无痛迁移

目前Apifox支持OpenApi,Postman,Jmeter等数据格式导入,方便旧有项目一键无痛迁移到Apifox,无需再次新建项目。

bc6c568d4808f7760b3596235527b6aa.gif
项目导入

项目也支持以html或者OpenApi,Markdown格式导出,可用于数据备份或合作人员查看。

2bf34d28f8ee92d0d6b945d66211bb89.gif
项目导出

7.Apihub

内置企业微信开放API,抖音开放API等第三方接口开放项目,接口可以直接在Apifox中调试,不需要到处找接口文档和手工填写接口。

fc60cc7c75b93f1595e7f9a553eef67a.png
API Hub

同时Apifox也提供了网页版Apihub,直接在网页端调试也完全没问题。

ec0dd78525ec34d50a9970f0cde99507.png
网页版 API   Hub

8.Web版本

除了客户端,还支持web版本,用户可以移动办公,任意切换设备,适合紧急加班这种情况。

31e01d1b85c8860f36ba989ca43dcb2d.png
官网 Web 版入口

9.完全免费

这个软件SaaS版本官方已经承诺永久免费,只有私有化部署是付费的。而且SaaS版本不限接口数量,不限项目人数,不限功能,非常厚道,对于日常开发来说,SaaS版本已经完全够用了。

08148ea375a598ea8f7715e3f46dc38c.png

10.社群答疑

Apifox官方还搭建了用户答疑群,扫二维码进微信群,各种使用过程中的疑问,官方工作人员都会贴心解答。

f2bd8ece8259a7d83f2223fbedf54b59.png
Apifox用户交流群

下载地址

介绍了Apifox这么多实用的功能,用上了才是真生产力!

如果小伙伴觉得好用,可以直接去他们的官网下载,复制下面的链接,粘贴到浏览器打开即可下载,或者点击阅读原文直达!

官网地址:http://www.apifox.cn/?utm_medium=WCSA&utm_source=ydym

芋道框架万字详解(前后端分离)、若依框架、yudao-cloud保姆级攻略 芋道开发框架,低代码平台 阅读详情

相关推荐

nCode:GlyphWorks案例教程一

nCode GlyphWorks案例一Comparing Frequency Content of Two Different Tests案例文件目标配置选择数据 Comparing Frequency Content of Two Different Tests 在本案例中,我们将比较来自两个不同测试的六个加速计通道的频率内容。将三轴加速度计放置在车辆的左前角和右前角,然后分别在两个不同的试验路面上行驶12分钟以上。 案例文件 此案例的文件(采用nCode DAC格式)位于nCode安装目录下的\demo

追月行的博客 1万+

Swagger界面丑、功能弱怎么破?用Postman增强下就给力了!

在使用Swagger的时候,你是否会有这种感觉:提交参数为JSON没法格式化,参数错了查找麻烦,返回结果没法折叠,太长了没法看!Swagger结合Postman使用后这一情况有很大改变,...

macrozheng的专栏 4612

基于强化学习的工业SCR脱硝系统控制算法设计与实现

本文提出了一种基于强化学习的工业SCR脱硝系统智能控制方法。针对SCR系统存在的非线性、大滞后和多变量耦合等控制难点,研究采用混合建模方法构建了精度在5%以内的系统模型,并设计了专门的强化学习环境。该方法通过定义合理的动作空间和状态空间,结合物理约束设计损失函数,利用深度强化学习算法优化氨喷射控制策略。相比传统PID控制,该智能控制器能更好地适应烟气参数波动,实现NOx排放的稳定控制,为工业环保设施提供了更优的自动化解决方案。

huanghm88的专栏 1456

芋道 Spring Boot API 接口文档 Swagger 入门

点击上方“芋道源码”,选择“设为星标”做积极的人,而不是积极废人!源码精品专栏原创 | Java 2020 超神之路,很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网络...

芋艿V 3408

国产安全芯片在密码算法国密体系下的性能适配策略

国密体系即国家商用密码体系,是保障信息安全的核心技术体系。自20世纪90年代末起步,国密体系经历了从无到有、从弱到强的发展历程。1999年,国家密码管理局成立,标志着国密体系的正式建立。2000年,国密SM1算法首次发布,开启了国密算法的标准化进程。此后,SM2、SM3、SM4等算法陆续推出,形成了完整的对称与非对称密码算法体系。:2010年,国密标准正式纳入国家标准体系,国密算法在金融、政务、通信等关键领域的应用得到明确规范。

qq_40552871的博客 1356

基于51单片机语音识别智能台灯设计

智能台灯;语音识别;STC89C52RC单片机

Benso_H的博客 5842

Apifox的使用

Apifox接口报错401,msg:“未授权”_apifox 401-优快云博客

m0_70752874的博客 419

标准测试测试数据STDF学习笔记

本文介绍了STDF(Standard Test Data Format)文件的结构与解析方法。首先详细说明了STDF记录的组成,包括记录头类型(REC_TYP和REC_SUB)、数据类型定义、时间日期格式以及无效数据标识。重点分析了25种主要记录类型的功能、数据内容和出现位置,如FAR、MIR、MRR等关键记录。然后介绍了基于pystdf开源工具的解析方法,包括自带脚本的使用和自编程解析流程,通过事件驱动机制处理数据流。特别指出测试数据是按照PIR→PTR/MPR/FTR→PRR的循环模式组织。文章为ATE

歌颂苦难的行为是无耻的; 1513

芋道框架中上传文件接口文档出错——knife4j4.5.0增强swagger3文档中入参对象中的文件属性字段不显示问题解决

芋道框架-knife4j4.5.0增强swagger3文档中入参对象中的文件属性字段不显示问题解决

猿小白的博客 719

AIGC游戏本地化:用AI实现多语言自动翻译

游戏本地化是游戏全球化战略的关键环节,传统人工翻译方式成本高、周期长。本文旨在探讨如何利用AIGC技术实现高效、准确、低成本的游戏多语言自动翻译解决方案。我们将覆盖从文本翻译到语音合成的完整本地化流程,重点关注AI技术在游戏特定语境下的应用优化。文章首先介绍游戏本地化的核心挑战和AI解决方案,然后深入讲解关键技术原理,接着通过实战项目演示具体实现,最后讨论应用场景和未来趋势。AIGC:人工智能生成内容,指利用AI技术自动生成文本、图像、音频等内容本地化(Localization)

AI 领航者的博客 1339

虚拟电厂功率预测最佳实践白皮书

虚拟电厂(VPP)通过聚合分散的可再生能源资源,为电网提供可观测、可调度和可交易的解决方案。本文提出了一套功率预测方法论,并给出LSTM实现脚本,涵盖资源接入、数据治理、预测模型设计及市场交易闭环。针对风-光-储-负荷混合场景,该方法论强调轻量化部署和滚动优化,可有效提升预测精度和调度收益。未来研究将融合深度气象预报和强化学习,进一步优化VPP的协同调度能力。

专注AI大模型,软件混淆,授权 377

干掉丑陋的 Swagger,堪称开发者的瑞士军刀!

这些问题产生的主要原因是,当前大部分研发团队的工作流程是这样的:旧协作模式这种模式带来的问题是:1.Swagger,postman,MockJS只能完成软件研发流程中某个环节的功能,造成完成接口设计,文档编写,调试,测试验证等工作需要使用好几个工具;2.更麻烦的是这些工具数据格式不互通,无法互相导入,造成用Swagger定义和编写完成接口后,在Postman,MockJS,Jmeter等工具还要再去手动填写一遍才能开始工作,增加了无意义的工作量。3.沟通成本总是被忽略不计,但实际上不仅占据了很大时间,各种沟

m0_72533993的博客 1935

Python爬虫技术应用:体育赛事直播数据抓取与分析

Web爬虫(Web Crawling)是一种通过模拟浏览器行为从网站获取数据的技术。发送请求:发送HTTP请求(通常是GET或POST请求)获取目标网页的HTML内容。解析网页:使用解析工具(如lxml)从HTML中提取出所需要的信息。存储数据:将抓取到的数据存储到数据库、文件或数据结构中,供后续分析和使用。数据分析与展示:使用数据分析工具(如PandasMatplotlib)对数据进行处理、清洗和可视化,生成有价值的报告和图表。Requests:用于发送静态网页的HTTP请求并获取响应。

2201_76125261的博客 1309

干掉丑陋的swagger,堪称开发者的瑞士军刀

静态的Swagger们跟不上频繁变更的代码 “为什么改了这个没告诉我”,“实际功能和文档上说的不一样啊”。这些话大家做开发的想必耳朵都听出老茧了。真不是故意的,有时候任务比较急,就先改了代码,想着以后再同步文档,然后就给忘了。项目更新又全靠社交软件通知,人一多难免有一两个没及时沟通到的。确实给合作的小伙伴带来麻烦,但说实话开发也挺委屈的。 这些问题产生的主要原因是,当前大部分研发团队的工作流程是这样的: 这种模式带来的问题是: 1.Swagger,postman,MockJS只能完成软件研发流

LiamHong_的博客 240

NTscan扫描工具

ntscan是一个扫描器,可以扫描没有密码和弱密码的共享,先到配置文件中填写猜测的用户名和密码,扫描过程中右侧出现的是扫描日志。

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面,电脑运行连游戏界面都一样大小,很怀旧,很真实,(英文版)强烈推荐,很小的文件,很难才找到的。

干掉丑陋的 Swagger,堪称开发者的瑞士军刀

真不是故意的,有时候任务比较急,就先改了代码,想着以后再同步文档,然后就给忘了。所见即所得,不易出错。作为一款研发全流程,接口全周期的生产力工具,这款软件真正完成了数据流的打通,在一个软件上就能实现接口设计--接口文档--接口调试--接口修改--接口mock--接口测试--接口自动化--接口迭代的工作流闭环;2.更麻烦的是这些工具数据格式不互通,无法互相导入,造成用Swagger定义和编写完成接口后,在Postman,MockJS,Jmeter等工具还要再去手动填写一遍才能开始工作,增加了无意义的工作量。

代码界的扛把子 126

C# WinForm 基于DirectShow.dll编写的程序,可边预览边保存视频,音频和图片

基于微软的DirectShow.dll的二次开发1.自动识别连接的摄像头跟麦克风且可以对其进行选择(默认选中第一个)2.可录制wmv和avi两种格式的视频并且都带有音频,avi可以录制的分辨率和帧数进行选择,wmv默认进行了淸晰度优化如不喜欢可去除代码中有相关提示3.可在预览点开之后进行拍照,也可边录制视频边拍照4.添加了视频和音频的压缩功能(酌情使用)这次二次开发发现C#对DirectShow的相关信息太少,这次做完也不敢藏私共享出来,还望大家指正

ruoyi-pro 代码生成api,swagger扫描不到

解决ruoyi-pro 代码生成后的api 在swagger-ui中未扫描到的问题。 背景:代码生成新的maven工程目录,目录下的接口不能被swagger扫描到。 解决方法: 1、将新创建的maven工程,加入到启动工程中,加载新创建的maven工程。 2、新增swagger配置类

噗嗤 2923

TMS_WebGMaps_1.9.8.0_Full_Source

TMS_WebGMaps_1.9.8.0_Full_Source 全源码 delphi cbuilder

如何使用swagger

原创出处 http://www.iocoder.cn/Spring-Boot/Swagger/ 「芋道源码」,相关代码还参考了苍穹外卖项目,实现的swagger的ui界面和苍穹外卖的一致。

m0_63834575的博客 388

yudaocode/ruoyi-vue-pro:Swagger API文档集成深度解析

在现代微服务架构中,API(Application Programming Interface,应用程序编程接口)作为系统间通信的桥梁,其文档质量直接影响开发效率和协作体验。传统的手动维护API文档方式存在更新不及时、格式不统一、维护成本高等痛点。 ruoyi-vue-pro项目采用Springdoc OpenAPI + Knife4j技术栈,实现了自动化API文档生成与管理,为开发者提供了完整...

gitblog_00380的博客 1203

一起来学 SpringBoot 2.x | 第十一篇:集成 Swagger 在线调试

点击上方“芋道源码”,选择“置顶公众号”技术文章第一时间送达!源码精品专栏 精尽 Dubbo 原理与源码 69 篇精尽 Netty 原理与源码 61 篇中文详细注释的开源...

芋道源码 396

Swagger使用说明

实体 参数说明:@ApiModel: value:实体对应表简述 description:描述 //value:实体对应表简述 //description:描述 @ApiModel(value = "能耗班组统计表",description = "能耗班组实体类") public class Demo extends BaseEntity { //value:描述 name:对应实体属性...

偏偏行 452

SpringBoot中配置Swagger,并自动生成接口文档

我们配置swagger是基于spring boot3.X+Java17的。这说明在我们的开发环境下,不能用原本的swaggerV3,而是要用springdoc-openapi。

ComboHu的博客 935
上一篇: 大疆被Figma禁用,请马上卸载Postman!国产软件Apipost火了!
下一篇: Spring Boot + Prometheus + Grafana 打造可视化监控,一目了然!
公众号-芋道源码
博客等级 码龄10年 1631粉丝 377原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值