作为一位后端开发,我们平时经常需要维护API文档、对API接口进行调试、有时候还得Mock数据。Postman虽然作为接口调试工具非常好用,但是对于维护API文档这类工作却不太合适。今天给大家推荐一款功能更强大的工具ApiKit,足以满足我们对API的各种需求,希望对大家有所帮助!
ApiKit简介
ApiKit 的定位是 API 管理 + Mock + 自动化测试 + 异常监控 + 团队协作。可以通过一种工具解决之前使用多种工具的数据同步问题。高效、及时、准确!
安装
ApiKit 的安装非常方便,直接下载安装包,安装即可,
下载地址:https://www.eolink.com/?utm_source=cpcs&utm_content=cpy07
API文档导入
ApiKit 的API文档导入功能非常强大,支持包括Swagger、Postman、YApi、Jmeter 等多种工具的导入。
1、按以上的功能入口路径进入导入API窗口。
2、选择对应的导入数据类型格式。
接口管理
接口设计
-
Apikit 中一共有5种创建API文档的方式:
-
新建API文档
-
导入API文档,详情可查看官网教程《导入、导出API文档》
-
从模板添加API文档,详情可查看官网教程《API文档模板》
-
自动生成API文档,详情可查看官网教程《自动生成API文档》
-
IDEA插件注释同步API文档
接口调试
我们再来体验下ApKit的调试功能,它也支持多协议
功能入口:API管理应用 / 选中某个项目 / API文档菜单 / 选中某一API文档 / 点击“测试”TAB
API文档测试页,可对该API文档描述的接口进行快速测试。API文档测试页分为地址控制栏、请求控制区、返回展示区,以及测试辅助工具区共四个部分。
使用脚本
ApiKit的自定义前置脚本
和后置脚本
非常强大,不仅支持简单的断言
和提取变量
,还能支持编写JS脚本。
前置脚本和后置脚本
API脚本分为 API前置脚本 和 API后置脚本 两种,分别对应API 请求前 和 返回数据后的两个阶段。你可以通过编写Javascript代码,在API前置脚本中改变请求参数,或者是在API后置脚本中改变返回结果。
API脚本功能常用于以下几种情况:
-
API请求时对Body进行整体签名加密,常用于银行等系统测试中
-
API返回结果后对Body进行解密,常用于反爬虫系统的测试中
-
发起的API请求会依次经过以下流程。其中如果你没有编写相应的API脚本,则会略过API脚本阶段。
Mock数据
添加及调用 Mock API
在瀑布流开发模式中,如果前端开发人员需要进行页面对接,需要后端先完成 API 的开发工作,因此前后端开发的进度会互相影响。
通过 Mock API,您可以事先编写好 API 的数据生成规则,由 API 研发管理平台 动态生成 API 的返回数据。开发人员通过访问 Mock API 来获得页面所需要的数据,完成对接工作。
Apikit 提供市面最强的Mock API能力体系:
如果用户仅需要快速的基于接口文档中的返回结果获取对应的随机数据,则可以通过简易Mock功能获取对应信息。
如果用户期望通过一个url模拟不同的请求信息时,获取对应个的返回结果模拟数据,则推荐使用高级Mock功能。
自动化测试
创建自动化测试项目
在API 自动化测试平台中,所有的测试用例都是以项目维度来进行管理,一个自动化测试项目可以从多个API文档项目中引用API信息来创建API测试用例。
进入 API自动化测试 项目列表页,点击添加按钮:
在弹窗中输入相应的信息,点击确定即可:
在创建项目时,您也可以指定一位空间内的成员成为该项目的初始管理员,他能够帮助您进行项目内的人员权限管理工作,如绑定空间内的成员到该项目,或者修改某个成员的操作权限等。
总结
ApiKit 确实是一款界面漂亮、功能强大的API接口工具。Postman有的接口调试功能它基本都有,还集成了接口文档管理、数据Mock、自动化测试等功能,强烈建议大家尝试下!
参考资料
https://help.eolink.com/tutorial/Apikit/c-1336