作为软件开发从业者,API调试是必不可少的一项技能,在这方面Postman做的非常出色。但是在整个软件开发过程中,API调试只是其中的一部分,还有很多事情Postman无法完成,或者无法高效完成,比如:API文档定义、APIMock、API自动化测试等等。Apifox就是为了解决这个问题而生的。
接口管理现状
常用解决方案
使用Swagger管理API文档使用Postman调试API使用MockJs等工具MockAPI数据使用JMeter做API自动化测试
存在的问题
维护不同工具之间数据一致性非常困难、低效。并且这里不仅仅是工作量的问题,更大的问题是多个系统之间数据不一致,导致协作低效、频繁出问题,开发测试人员痛苦不堪。
开发人员在Swagger定义好文档后,接口调试的时候还需要去Postman再定义一遍。前端开发Mock数据的时候又要去MockJs定义一遍,还需要手动设置Mock规则。测试人员需要去JMeter再定义一遍。前端根据MockJsMock出来的数据开发完,后端根据Swagger定义的接口文档开发完,各自都试测试通过了,本以为可以马上上线,结果一对接发现各种问题:
开发过程中接口变更了,只修改了Swagger,但是没有及时同步修改MockJs。后端开发的接口数据类型和文档不一致,肉眼难以发现问题。
同样,测试在JMeter写好的测试用例,真正运行的时候也会发现各种不一致。
时间久了,各种不一致会越来越严重。
Apifox解决方案
如何解决这些问题
Apifox定位
Apifox是API文档、API调试、APIMock、API自动化测试一体化协作平台。
通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据Mock、接口测试就可以直接使用,无需再次定义;接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!
Apifox宗旨
节省研发团队的每一分钟!
Apifox功能
接口设计:Apifox接口文档遵循OpenApi0(原Swagger)、JSONSchema规范的提供了非常好用的可视化文档管理功能,零学习成本,非常高效。并且支持在线分享接口文档。数据模型:可复用的数据结构,定义接口返回数据结构及请求参数数据结构时可直接引用。支持模型直接嵌套引用,直接JSON/XML智能导入,支持oneOf、allOf等高级组合模式。接口调试:Postman有的功能,比如环境变量、前置/后置脚本、Cookie/Session全局共享等功能,Apifox都有,并且比Postman更高效好用。接口运行完之后点击保存为用例按钮,即可生成接口用例,后续可直接运行接口用例,无需再输入参数,非常方便。自定义脚本100%兼容Postman语法,并且支持运行javascript、java、python、php、js、BeanShell、go、shell、ruby、lua等各种语言代码。接口用例:通常一个接口会有多种情况用例,比如参数正确用例、参数错误用例、数据为空用例、不同数据状态用例等等。运行接口用例时会自动校验数据正确性,用接口用例来调试接口非常高效。接口数据Mock:内置Mocjs规则引擎,非常方便mock出各种数据,并且可以在定义数据结构的同时写好mock规则。支持添加“期望”,根据请求参数返回不同mock数据。最重要的是Apifox零配置即可Mock出非常人性化的数据,具体在本文后面介绍。数据库操作:支持读取数据库数据,作为接口请求参数使用。支持读取数据库数据,用来校验(断言)接口请求是否成功。接口自动化测试:提供接口集合测试,可以通过选择接口快速创建测试集。目前接口自动化测试更多功能还在开发中,敬请期待!目标是:JMeter有的功能基本都会有,并且要更好用。快捷调试:类似Postman的接口调试方式,主要用途为临时调试一些无需文档化的接口,无需提前定义接口即可快速调试。代码生成:根据接口及数据数据模型定义,系统自动生成接口请求代码、前端业务代码及后端业务代码。团队协作:Apifox天生就是为团队协作而生的,接口云端实时同步更新,成熟的团队/项目/成员权限管理,满足各类企业的需求。
Apifox做的不仅仅是数据打通
如果你认为Apifox只做了数据打通,来提升研发团队的效率,那就错了。Apifox还做了非常多的创新,来提升开发人员的效率。
接口支持“用例管理”
通常一个接口会有多种情况用例,比如正确用例参数错误用例数据为空用例不同数据状态用例。定义接口的时候定义好这些不同状态的用例,接口调试的时候直接运行,非常高效。
“数据模型”定义、引用
可以独立定义数据模型,接口定义时可以直接引用数据模型,数据模型之间也可以相互引用。同样的数据结构,只需要定义一次即可多处使用;修改的时候只需要修改一处,多处实时更新,避免不一致。
调试时“自动校验”数据结构
使用Apifox调试接口的时候,系统会根据接口文档里的定义,自动校验返回的数据结构是否正确,无需通过肉眼识别,也无需手动写断言脚本检测,非常高效!
Apifox自动校验数据结构
“可视化”设置断言
设置断言:
Apifox设置断言
运行后,查看断言结果:
“可视化”设置提取变量
支持数据库操作
“零配置”Mock出非常人性化的数据
先放一张对比下Apifox和其他同类工具零配置mock出来的数据效果:
ApifoxMock数据结果对比同类工具
可以看出Apifox零配置Mock出来的数据和真实情况是非常接近的,前端开发可以直接使用,而无需再手动写mock规则。
Apifox如何做到高效率、零配置生成非常人性化的mock数据
Apifox根据接口定义里的数据结构、数据类型,自动生成mock规则。Apifox内置智能mock规则库,根据字段名、字段数据类型,智能优化自动生成的mock规则。如:名称包含字符串image的string类型字段,自动mock出一个片地址URL;包含字符串time的string类型字段,自动mock出一个时间字符串;包含字符串city的string类型字段,自动mock出一个城市名。Apifox根据内置规则,可自动识别出片、头像、用户名、手机号、网址、日期、时间、时间戳、邮箱、省份、城市、地址、IP等字段,从而Mock出非常人性化的数据。除了内置mock规则,用户还可以自定义规则库,满足各种个性化需求。支持使用正则表达式、通配符来匹配字段名自定义mock规则。
生成在线接口文档
Apifox项目可“在线分享”API文档,分享出去的API文档可设置为公开或需要密码访问,非常方便与外部团队协作。
体验地址:https://www.apifox.cn/apidoc/shared-ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285
代码自动生成
根据接口模型定义,自动生成各种语言/框架的业务代码和接口请求代码。目前Apifox支持130种语言及框架的代码自动生成。
更重要的是:你可以通过自定义代码模板来生成符合自己团队的架构规范的代码,满足各种个性化的需求。
0、导入、导出
支持导出OpenApi(Swagger)、Markdown、Html等数据格式,因为可以导出OpenApi格式数据,所以你可以利用OpenApi(Swagger)丰富的生态工具完成各种接口相关的事情。支持导入OpenApi(Swagger)、Postman、apiDoc、HAR、RAML、RAPYApi、Eolinker、NEI、DOClever、ApiPost、Apizza、ShowDoc、APIBlueprint、I/ODocs、WADL、GoogleDiscovery等数据格式,方便旧项目迁移。支持定时自动导入OpenApi(Swagger)、apiDoc、Apifox格式数据。
后续功能规划
发布ApifoxWEB版,支持在浏览器端使用Apifox。接口性能测试支持。支持插件市场,可以自己开发插件。开放ApifoxAPI,允许开发者通过API调用Apifox的功能。支持更多接口协议,如GraphQL、gRPC、websocket等。支持离线使用,项目可选择在线同步还是仅本地存储。
更多Apifox功能截
接口调试
自定义mock规则
智能mock
接口自动化
项目导入
项目导出
多主题可选
Apifox下载地址
文章为作者独立观点,不代表股票交易接口观点