共计 2255 个字符,预计需要花费 6 分钟才能阅读完成。
作为一位后端开发,咱们平时常常须要保护 API 文档、对 API 接口进行调试、有时候还得 Mock 数据。Postman 尽管作为接口调试工具十分好用,然而对于保护 API 文档这类工作却不太适合。明天给大家举荐一款性能更弱小的工具 Apifox,足以满足咱们对 API 的各种需要,心愿对大家有所帮忙!
SpringBoot 实战电商我的项目 mall(50k+star)地址:https://github.com/macrozheng/mall
Apifox 简介
Apifox 的定位是Postman + Swagger + Mock + JMeter
,具备 API 文档治理、API 调试、API Mock、API 自动化测试等性能。能够通过一种工具解决之前应用多种工具的数据同步问题。高效、及时、精确!
装置
- Apifox 的装置十分不便,间接下载安装包解压装置即可,下载地址:https://www.apifox.cn/
- 官网十分贴心地提供了
示例我的项目
,间接关上即可体验 Apifox 的性能,看下界面还是很漂亮的;
- 咱们本人应用的话首先须要
新建团队
,便于团队成员之间协同工作;
- 而后在团队中
新建我的项目
,新建胜利后咱们就能够开始应用 Apifox 的弱小性能了!
API 文档导入
Apifox 的 API 文档导入性能十分弱小,反对包含 Swagger、Postman、YApi、ShowDoc 等多达 20 种工具的导入。接下来咱们通过应用之前
mall-tiny-swagger
我的项目中的接口,来体验下它的导入性能!
- 首先咱们抉择
新建接口
按钮,抉择导入
;
- 而后关上导入界面,抉择
Swagger->URL 导入
,输出 Swagger 的数据 URL;
- 导入时将显示
导入预览
,显示要导入的接口
和数据模型
,Apifox 将会把咱们接口返回的实体类转换为数据模型,以便进行复用;
- 导入胜利后界面成果如下,Apifox 将查看文档和批改文档做了辨别,不便咱们治理接口文档。
接口治理
尽管从 Swagger 中导入的接口文档曾经很具体了,然而为了体验 Apifox 更为弱小的性能,咱们有时候还是须要编辑下接口信息的。
接口设计
- 看下 Apifox 的申请参数界面,十分具体!
- 再看下 Apifox 返回后果界面,反对折叠,这个很多工具都是没有的;
- 再看下 Apifox 的
批改文档
界面,反对增加状态、分组和标签。
接口调试
咱们再来体验下 Apifox 的调试性能,比 Postman 更弱小!
- 在咱们开发接口时,很多时候须要分不同的环境,Apifox 默认给咱们分了
测试环境
、正式环境
、Mock 服务
,这三个根本也够用了;
- 在调试接口之前,咱们得先设置好环境所对应的
前置 URL
,比方这里咱们设置了测试环境
的;
- 在 Apifox 中咱们能够应用
接口用例
来调试咱们的接口,接口用例能够保留咱们输出的参数,以便之后测试应用;
- Apifox 反对在接口调用前后做自定义操作,比方咱们能够在
后置操作
中增加一个断言
,返回后果中code 等于 200
示意操作胜利;
- 此时咱们输错明码来调用下接口,断言会间接提醒咱们后果和预期不合乎;
- 有些接口咱们须要传入
Authorization
头能力拜访;
- 这种拜访咱们能够通过
环境变量
来实现,首先在登录接口中增加后置操作
,抉择提取变量
,将返回的 token 提取到环境变量AUTH_TOKEN
中;
- 而后批改接口文档,在
Header
中设置须要传入Authorization
头;
- 接下来在
接口用例
中通过表达式应用Authorization
头即可失常拜访须要登录认证的接口了。
应用脚本
Apifox 的自定义
前置操作
和后置操作
十分弱小,不仅反对简略的断言
和提取变量
,还能反对编写 JS 脚本。
- 例如之前咱们判断操作胜利,断言
code 等于 200
能够应用脚本这样实现;
- 此时咱们输错明码来调用下接口,断言会间接提醒咱们后果和预期不合乎。
Mock 数据
在咱们后端接口没有开发实现,前端开发须要数据时,往往能够通过 Mock 来提供数据,Apifox 的 Mock 数据性能也是很弱小的。
- Apifox 号称能依据你数据模型中的字段名称
智能 Mock
,让咱们来看看它的规定;
- 其实默认的 Mock 规定有时候并不是很欠缺,比方咱们来看下它 Mock 的数据;
- 此时咱们能够在
数据模型
中批改,能够让 Mock 的数据更加人性化一点,比方咱们能够将各种状态设置为枚举类型;
- 还能够将 logo 字段通过
@image
这种形式设置为图片类型;
- 从新设置一下之后,人性化多了;
- 接下来只需把环境改为
Mock 服务
就能够调用 Mock 数据的接口了!
测试治理
Apifox 不仅能反对接口调试,还反对创立测试用例进行批量测试以及性能测试。
- 首先咱们能够在
测试治理
中创立测试用例;
- 之后抉择
从接口用例导入
,抉择好须要导入的接口用例;
- 抉择好
运行环境
后,点击运行进行批量测试;
- 测试实现后即可显示测试报告;
- 如果你想进行性能测试的话,在测试界面抉择好
线程数
即可;
- 测试实现后,能够通过
导出报告
来查看更为具体的报告信息。
主题设置
集体比拟习惯 暗色
主题,Apifox 也是能够抉择 亮色
主题和主色的,间接在设置中能够进行切换。
总结
Apifox 的确是一款界面丑陋、功能强大的 API 接口工具。Postman 有的接口调试性能它根本都有,还集成了接口文档治理、数据 Mock、自动化测试等性能,强烈建议大家尝试下!
参考资料
官网文档:https://www.apifox.cn/help/
我的项目源码地址
https://github.com/macrozheng…
本文 GitHub https://github.com/macrozheng/mall-learning 曾经收录,欢送大家 Star!