作为开软件开发从业者,API 调试是必不可少的一项技能,在这方面 Postman 做的非常出色。但是在整个软件开发过程中,API 调试只是其中的一部分,还有很多事情 Postman 无法完成,或者无法高效完成,比如:API 文档定义、API Mock、API 自动化测试等等。Apifox 就是为了解决这个问题而生的。

接口管理现状

一、常用解决方案

  1. 使用 Swagger 管理 API 文档

  2. 使用 Postman 调试 API

  3. 使用 RAP 等工具 Mock API 数据

  4. 使用 JMeter 做 API 自动化测试

二、存在的问题

维护不同工具之间数据一致性非常困难、低效。并且这里不仅仅是工作量的问题,更大的问题是多个系统之间数据不一致,导致协作低效、频繁出问题,开发测试人员痛苦不堪。

  1. 开发人员在 Swagger 定义好文档后,接口调试的时候还需要去 Postman 再定义一遍。

  2. 前端开发 Mock 数据的时候又要去 RAP 定义一遍,还需要手动设置 Mock 规则。

  3. 测试人员需要去 JMeter 再定义一遍。

  4. 前端根据 RAP Mock 出来的数据开发完,后端根据 Swagger 定义的接口文档开发完,各自都试测试通过了,本以为可以马上上线,结果一对接发现各种问题:

  • 开发过程中接口变更了,只修改了 Swagger,但是没有及时同步修改 RAP。

  • 后端开发的接口数据类型和文档不一致,肉眼难以发现问题。

同样,测试在 JMeter 写好的测试用例,真正运行的时候也会发现各种不一致。

时间久了,各种不一致会越来越严重。

Apifox 解决方案

一、如何解决这些问题

1、Apifox 定位

Apifox = Postman + Swagger + Mock + JMeter

Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台。

通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据 Mock、接口测试就可以直接使用,无需再次定义;接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!

2、Apifox 功能

  1. 接口设计:Apifox 接口文档遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 规范的同时,提供了非常好用的可视化文档管理功能,零学习成本,非常高效。并且支持在线分享接口文档。

  2. 数据模型:可复用的数据结构,定义接口返回数据结构请求参数数据结构(仅 JSON 和 XML 模式)时可直接引用。支持模型直接嵌套引用,直接 JSON/XML 智能导入,支持 oneOf、allOf 等高级组合模式。

  3. 接口调试:Postman 有的功能,比如环境变量、前置/后置脚本、Cookie/Session 全局共享 等功能,Apifox 都有,并且比 Postman 更高效好用。接口运行完之后点击保存为用例按钮,即可生成接口用例,后续可直接运行接口用例,无需再输入参数,非常方便。自定义脚本 100% 兼容 Postman 语法,并且支持运行javascript、java、python、php、js、BeanShell、go、shell、ruby、lua等各种语言代码。

  4. 接口用例:通常一个接口会有多种情况用例,比如参数正确用例、参数错误用例、数据为空用例、不同数据状态用例等等。运行接口用例时会自动校验数据正确性,用接口用例来调试接口非常高效。

  5. 接口数据 Mock:内置 Mock.js 规则引擎,非常方便 mock 出各种数据,并且可以在定义数据结构的同时写好 mock 规则。支持添加“期望”,根据请求参数返回不同 mock 数据。最重要的是 Apifox 零配置 即可 Mock 出非常人性化的数据,具体在本文后面介绍。

  6. 数据库操作:支持读取数据库数据,作为接口请求参数使用。支持读取数据库数据,用来校验(断言)接口请求是否成功。

  7. 接口自动化测试:提供接口集合测试,可以通过选择接口(或接口用例)快速创建测试集。目前接口自动化测试更多功能还在开发中,敬请期待!目标是:JMeter 有的功能基本都会有,并且要更好用。

  8. 快捷调试:类似 Postman 的接口调试方式,主要用途为临时调试一些无需文档化的接口,无需提前定义接口即可快速调试。

  9. 代码生成:根据接口及数据数据模型定义,系统自动生成接口请求代码前端业务代码后端业务代码

  10. 团队协作:Apifox 天生就是为团队协作而生的,接口云端实时同步更新,成熟的团队/项目/成员权限管理,满足各类企业的需求。

二、Apifox 做的不仅仅是数据打通

如果你认为 Apifox 只做了数据打通,来提升研发团队的效率,那就错了。Apifox 还做了非常多的创新,来提升开发人员的效率。

1、接口支持“用例管理”

通常一个接口会有多种情况用例,比如 正确用例 参数错误用例 数据为空用例 不同数据状态用例。定义接口的时候定义好这些不同状态的用例,接口调试的时候直接运行,非常高效。

2、“数据模型”定义、引用

可以独立定义数据模型,接口定义时可以直接引用数据模型,数据模型之间也可以相互引用。同样的数据结构,只需要定义一次即可多处使用;修改的时候只需要修改一处,多处实时更新,避免不一致。

3、调试时“自动校验”数据结构

使用 Apifox 调试接口的时候,系统会根据接口文档里的定义,自动校验返回的数据结构是否正确,无需通过肉眼识别,也无需手动写断言脚本检测,非常高效!

4、“可视化”设置断言

设置断言:

运行后,查看断言结果:

5、“可视化”设置提取变量

6、支持数据库操作

7、“零配置”Mock 出非常人性化的数据

先放一张图对比下 Apifox 和其他同类工具 零配置 mock 出来的数据效果:

可以看出 Apifox 零配置 Mock 出来的数据和真实情况是非常接近的,前端开发可以直接使用,而无需再手动写 mock 规则。

Apifox 如何做到高效率零配置生成非常人性化的 mock 数据

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

  2. Apifox 内置智能 mock 规则库,根据字段名、字段数据类型,智能优化自动生成的 mock 规则。如:名称包含字符串imagestring类型字段,自动 mock 出一个图片地址 URL;包含字符串timestring类型字段,自动 mock 出一个时间字符串;包含字符串citystring类型字段,自动 mock 出一个城市名。

  3. Apifox 根据内置规则,可自动识别出图片、头像、用户名、手机号、网址、日期、时间、时间戳、邮箱、省份、城市、地址、IP 等字段,从而 Mock 出非常人性化的数据。

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

8、生成在线接口文档

Apifox 项目可“在线分享” API 文档,分享出去的 API 文档可设置为公开或需要密码访问,非常方便与外部团队协作。

体验地址:https://www.apipark.cn/s/ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285

9、代码自动生成

根据接口模型定义,自动生成各种语言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的业务代码(如 Model、Controller、单元测试代码等)和接口请求代码。目前 Apifox 支持 130 种语言及框架的代码自动生成。

更重要的是:你可以通过自定义代码模板来生成符合自己团队的架构规范的代码,满足各种个性化的需求。

10、导入、导出

  1. 支持导出 OpenApi (Swagger)MarkdownHtml 等数据格式,因为可以导出OpenApi格式数据,所以你可以利用 OpenApi (Swagger) 丰富的生态工具完成各种接口相关的事情。

  2. 支持导入 OpenApi (Swagger)PostmanHARRAMLRAP2YApiEolinkerNEIDOCleverApiPostApizzaShowDocAPI BlueprintI/O DocsWADLGoogle Discovery等数据格式,方便旧项目迁移。

三、后续功能规划

  1. 接口性能测试支持(类似 JMeter)。

  2. 支持插件市场,可以自己开发插件。

  3. 支持更多接口协议,如GraphQLwebsocket等。

  4. 支持离线使用,项目可选择在线同步(团队协作)还是仅本地存储(单机离线使用)。

四、更多 Apifox 功能截图

五、Apifox 下载地址

请访问 Apifox 官网下载:apifox.cn

往期推荐

再见收费的Navicat!操作所有数据库靠它就够了!

MyBatis原生批量插入的坑与解决方案!

@Value竟然能玩出这么多花样


再见 Postman!Apifox 才是 YYDS!相关推荐

  1. 扔掉 Postman,Apifox 才是 YYDS!

    作为软件开发从业者,API 调试是必不可少的一项技能,在这方面 Postman 做的非常出色.但是在整个软件开发过程中,API 调试只是其中的一部分,还有很多事情 Postman 无法完成,或者无法高 ...

  2. Markdown 编辑器才是yyds|CSDN编辑器测评

    前言 今天小编为大家介绍一款编辑器,也正是小编书写这篇文章所使用的Markdown编辑器,正是广大博友想要发布文章的工具.那么 你知道他的都有哪些方便之处么 下面小编带你了解一下 Markdown是什 ...

  3. 再见Navicat!这个工具才是YYDS!

    喜欢自己倒腾数据库的程序猿小伙伴想必这几天都看过一个新闻,就是数据库管理工具Navicat Premium被投毒的事件. 此毒是指木马病毒,因为Navicat Premium作为一款广受欢迎的收费工具 ...

  4. 再见了 React、Angular,Vue3 才是 yyds

    切记一定要看到最后!!! 最近看到一篇文章上面是一作者资讯一位IT前辈,问他怎么看待工作 2 年的前端开发,月薪就高达 30k.40k 的现状. 他说,在众多编程技术中,前端算比较容易入门和提升的,可 ...

  5. 再见Postman,这款API神器更好用!

    代码未动,文档先行 其实大家都知道 API 文档先行的重要性,但是在实践过程中往往会遇到很多困难. 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因是 ...

  6. 再见postman,被这个一站式接口管理工具折服了

    前端mock数据的尴尬 作为前端开发,拿到产品的需求,和后端讨论接口和数据结构的定义后,就可以开始前端的开发工作了,但后端一般无法在很短的时间内把接口开发完成,提供给前端使用,前端为了在开发过程中模拟 ...

  7. 这回稳了,蓝桥杯才是yyds!

    为了提高自己的编程能力,很多人会选择参加比赛.而这些比赛中,连续三年入选"全国普通高校学科竞赛排行榜"的蓝桥杯大赛,可以综合测评加分,优先奖学金评定.升学考研加分,yyds !! ...

  8. ResNet才是YYDS!新研究:不用蒸馏、无额外数据,性能还能涨一波

    ©作者 | 杜伟.张倩 来源 | 机器之心 基线:我要是用上最新的训练流程,性能还能涨一波. 在计算机视觉领域,何恺明等人 2015 年提出的 ResNet(deep residual network ...

  9. FAIR 何恺明、Piotr、Ross等新作,MAE才是YYDS!仅用ImageNet1K,Top-1准确率87.8%!

    关注公众号,发现CV技术之美 介绍一篇今天新出的论文. ▊ 写在前面 在本文中,作者证明了masked autoencoders(MAE) 是一种可扩展的计算机视觉自监督学习方法.本文的MAE方法很简 ...

最新文章

  1. java 变量的线程可见性_Java多线程——变量可见性
  2. Linux之bash编程基本语法
  3. pyhon简单比较文本相似度的方法
  4. Hadoop-2.2.0学习之二HDFS联盟
  5. Ansible and FileBeta
  6. RocketMQ开发指导之一——RocketMQ简介
  7. LVS 实现负载均衡
  8. 常用的电气制图软件有哪些?以及各自的优缺点
  9. AD制作gerber文件详细步骤
  10. 金鳞岂是池中物,一遇风云便化龙
  11. 谈一谈对JS闭包的理解
  12. 【Git学习笔记二】时光穿梭机
  13. setInterval 函数的使用例子
  14. 华为路由交换设备配置综合实验(实验六合一)
  15. 重庆市涪陵创新计算机学校图片,重庆市涪陵创新计算机学校寝室图片、学校环境好吗...
  16. NSDictionary转换成JSON字符串
  17. java 国家法定节假日和双休日判断工具类
  18. 强化网络互连设备安全配置脚本
  19. No start hook file found ($HOOK_MARATHON_START)正确处理姿势
  20. 3.5折怎么用计算机算,论几十块钱的小主机能干什么?手把手教你改造神器!(32位黑裙晖安...

热门文章

  1. python 命名空间冲突_python-命名空间
  2. mongotemplate中save抛出异常_异常处理的三个好习惯 | Python 工匠
  3. python,pytorch:读取,保存,显示图片
  4. Angular实现dialog对话框封装
  5. docker-compose 运行 Flask 应用最佳实践
  6. HDU 4812 D Tree
  7. ELK系列~对fluentd参数的理解
  8. linux/unix 段错误捕获【续】
  9. Lotus Notes Domino 监控
  10. DotNet程序员是不是最不幸福?