接口管理现状
一、常用解决方案
-
使用 Swagger 作为接口文档工具
-
使用 Postman 调试接口
-
使用 RAP Mock 数据
-
使用 JMeter 做接口自动化测试
二、存在的问题
维护不同工具之间数据一致性非常困难、非常低效。并且这里不仅仅是工作量的问题,更大的问题是多个系统之间数据不一致,导致协作低效,频繁出问题,开发人员痛苦不堪。
-
开发人员在 Swagger 定义好文档后,接口调试的时候还需要去 Postman 再定义一遍。
-
前端开发 Mock 数据的时候又要去 RAP 定义一遍,手动设置好 Mock 规则。
-
测试人员需要去 JMeter 定义一遍。
-
前端根据 RAP Mock 出来的数据开发完,后端根据 Swagger 定义的接口文档开发完,各自测试测试通过了,本以为可以马上上线,结果一对接发现各种问题:原来开发过程中接口变更,只修改了 Swagger,但是没有及时同步修改 RAP。
-
同样,测试在 JMeter 写好的测试用例,真正运行的时候也会发现各种不一致。
-
时间久了,各种不一致会越来越严重。
ApiKit 解决方案
一、如何解决这些问题
1、ApiKit定位
ApiKit = API 管理 + Mock + 自动化测试 + 异常监控 + 团队协作
通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据 Mock、接口测试就可以直接使用,无需再次定义;接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!
2、Apikit 功能
-
智能且强大的 Mock
前端团队可以在 API 还没开发完成的情况下,借助 Mock API 实现预对接,加速开发进程。测试团队可以通过 Mock API 解耦不必要的系统,完成集成测试
-
快速生成和管理所有 API 文档
无论您使用什么语言开发,Apikit 都可以帮您统一规范地管理起来,并提供强大的文档管理、协作、测试、分享功能
-
零代码自动化测试
Apikit 提供了 API 测试功能,支持自动生成测试数据,能够通过Javascript 对请求报文、返回结果等进行加解密、签名等处理;提供强大、易用的企业级 API 自动化测试解决方案,5分钟快速上手,提高 95% 以上回归测试效率,人人皆可使用的“零代码”自动化测试平台;
-
领先的 API 团队协作功能
无论您使用什么语言开发,Apikit 都可以帮您统一规范地管理起来,并提供强大的文档管理、协作、测试、分享功能
-
还有更多的 Devops 功能
API 异常监控,对接CI/CD、DevOps 平台,支持主流IM ,也可通过自由拓展。
二、ApiKit 做的不仅仅是数据打通
如果你认为 ApiKit 只做了数据打通,来提升研发团队的效率,那就错了。ApiKit 还做了非常多的创新,来提升开发人员的效率。
三、更多 Apikit 功能截图
HTTP 测试
功能入口:API管理应用 / 选中某个项目 / API文档菜单 / 选中某一API文档 / 点击“测试”TAB
API文档测试页,可对该API文档描述的接口进行快速测试。API文档测试页分为地址控制栏、请求控制区、返回展示区,以及测试辅助工具区共四个部分。
发起快速测试
功能入口:API管理应用 / 选中某个项目 / API文档菜单 / 选中标签页旁加号
如果未创建该接口文档,仅临时调试接口,则可创建API快速测试页面。可在这个页面输入接口相关的信息并进行快速测试。具体各协议的测试字段配置,可以查看官网
新建API文档
功能入口:API管理应用 / 选中某个项目 / API文档菜单 / 点击“+ API”按钮
新建API文档是最常用的API文档创建方法。
-
默认新建在根目录下
-
点击“+ API”按钮新建的文档,默认创建在根目录下。若想在某个文档目录下新建,可以点击“+ API”按钮前,先选中对应的API目录文件夹。或者在新建文档页面中,切换文档分组。
分享 API、项目
开启/关闭在线分享
您可以在线分享项目给团队以外的人,其他人可以通过分享链接在线查看API文档并且进行API测试。通过这种方式查看API文档不需要注册账号,用户可方便查看接口文档和测试接口。
在项目内,点击进入项目管理菜单,选择 在线分享,即可启用或禁用项目在线分享功能。
进入点击 项目页面顶部的 分享项目 按钮,亦可启用或禁用项目在线分享功能。
添加高级Mock
在“高级Mock”页下,点击“添加Mock”,即会有添加Mock信息弹窗。
除了高级Mock期望名称外,其余需输入的信息分成两个部分:请求触发条件和响应内容
创建自动化测试项目
在API 自动化测试平台中,所有的测试用例都是以项目维度来进行管理,一个自动化测试项目可以从多个API文档项目中引用API信息来创建API测试用例。
进入 API自动化测试 项目列表页,点击添加按钮:
在弹窗中输入相应的信息,点击确定即可。
API 异常监控
全局告警设置
邮件告警
若需要对所有监控项目设置全局的告警通知,可以在API监控的项目列表页面,选择 异常告警页面 :
在这里设置的告警信息,对所有项目有效。
创建项目环境
进入项目详情页,点击侧边栏的 环境 ,进入项目环境管理页面后,点击添加项目环境按钮:
还有诸如:脚本/函数、项目管理、工作空间等等功能,值得你去好好探索研究一番。