一、ApiKit 整体介绍：

1、接口管理的需求与现状：

在软件项目研发的过程中，必然存在以下几个需求：

• API 接口文档的管理，常用的解决方案有 Swagger

• API 接口的调试，常用的解决方案有 Postman

• API 接口的自动化测试，缩小版本迭代过程的测试周期，提高版本的代码质量，常用的解决方案有 JMeter

• API 接口数据的 Mock，节省数据构造的时间、以及告别等待后端接口，常用的解决方案有 MockJs

虽然 Swagger、Postman、JMeter、MockJS 各自能非常出色地满足上面研发流程中的不同环节的需求，但是由于完成 接口设计、文档编写、调试、数据Mock、测试验证 等工作需要使用好几个不同工具，所以实际中使用时，会遇到如下情况：

(1) 开发人员基于Swagger定义好文档之后，接口调试时还需要去 Postman 再定义一遍 (2) 前端开发 Mock 数据时又要使用 MockJs 定义一遍，还需要手动设置 Mock 规则 (3) 测试人员在构造测试用例时需要使用 JMeter 再定义一遍 (4) 前端基于 MockJs Mock 出来的数据开发完，后端根据 Swagger 定义的接口文档开发完，各自都试测试通过了，本以为可以马上上线，结果一对接发现各种问题： a.开发过程中接口变更了，但只修改了 Swagger，没有及时同步修改 MockJs b.后端开发的接口数据类型和文档不一致，肉眼难以发现问题。 (5) 同样，测试在 JMeter 写好的测试用例，真正运行的时候也会发现各种不一致。 (6) 随着时间的推移，各种不一致会越来越严重。

总结下来就是存在以下问题：

（1）多系统数据不互通，无法相互导入，造成用 Swagger 定义和编写接口后，API设计者、前端开发、后端开发、测试人员 在使用 Postman、MockJS、Jmeter 等工具时还需要重复大量相同的工作，效率低。

（2）数据一致性困难。由于数据不互通，每次变更接口内容，都需要不同角色去修改多套系统，一致性的维护非常困难，且随时间的推移越来越严重。

（3）多套系统间无法团队协作，变更无法及时通知和同步到团队成员手中，导致各种沟通不及时、协作低效、频繁出问题。

2、什么是ApiKit：

那有没有一款工具能够实现上述功能的统一，从而解决刚才提到的问题呢？答案肯定是有的，也就是我们这篇文章的主人公 ApiKit。

官方对 ApiKit 定位是： ApiKit = API 管理 + Mock + 自动化测试 + 异常监控 + 团队协作 ，作为一款接口全周期的生产力工具、一站式接口管理平台，它真正实现了数据流的打通，在一个软件上就能实现 接口设计-> 接口文档 -> 接口调试 -> 接口修改 -> 接口mock -> 接口测试 -> 接口自动化 -> 接口迭代 的工作流闭环，后端，前端，测试不同领域既能各取所需，又能协同合作。

通过 ApiKit，我们只要定义接口文档，就可以直接使用 接口调试、数据Mock、接口测试 等功能，无需再次定义，在接口调试完成后即可保证和接口文档定义完全一致，高效、及时、准确！也就是说，ApiKit 主要为我们提供了这 5 类功能：API 文档设计、API 接口调试、API 自动化测试、API 数据 Mock、团队协作

二、接口管理模块：

1、接口的设计（swagger）：

接口设计，即定义接口文档规范，如接口请求路径、参数、返回值、数据结构等， ApiKit 的接口文档遵循 OpenAPI 规范，不仅具备 swagger 的核心功能 ，同时具备更多的优势：

• 可视化的 API 文档设计和管理页面，零学习成本，上手使用成本低

• 接口和文档一体化，修改接口可同步修改文档，节省维护文档的精力

• 支持在线分享 API 文档，方便与外部团队协作。

• 支持数据模型，接口间可以复用相同数据结构。

2、接口的调试（postman）

完成接口与文档设计后，就可以直接运行接口来调试了。ApiKit 的接口文档功能和调试功能一体，调试和修改文档能节省掉切换工具和系统间同步数据的成本。

 

测试内容保存为API文档

若测试没问题，可点击右上角的“保存为新API”，快速把测试数据保存为API文档，方便下次调试。

 

3、代码的自动生成：

ApiKit 的代码生成功能，可以根据接口与数据模型的定义，自动生成各种语言的业务代码，让服务调用端可以少写点代码，提高效率同时也提高了准确性。

4、数据的导入：

说到这里，如果真的要使用ApiKit，肯定会考虑到我们的业务已经迭代了这么久了，存在大量的接口，重新用ApiKit去一个个定义好接口文档，肯定不太现实吧？别担心，由于 ApiKit 支持 OpenApi、Postman，Jmeter 等数据格式导入，所以旧项目可以一键无痛迁移到Apikit，无需再次新建项目。

 

5、自动生成文档：

 

测试内容保存为API文档

若测试没问题，可点击右上角的“保存为新API”，快速把测试数据保存为API文档，方便下次调试。

 

三、数据Mock模块：

前端开发往往依赖于后端数据接口，但很多时候前后端开发步调不一致，在后端接口还没开发完成之前，前端通常很难开工。而 Mock 功能就是用来解决这个问题的，有了 Mock 工具之后，前端可以通过 Mock 工具来制造假数据接口来进行模拟接口调用，前后端可以同步进入开发，进而保障前端的开发进度。

 

四、自动化测试模块：

ApiKit 的自动化测试是基于测试用例实现的，测试用例，就是将多个接口有序地组合在一起运行，用来测试一个完整业务流程，ApiKit 的自动化测试有如下几个特色：

• 支持引用 API 文档中定义的接口 或者 引用接口用例 快速生成测试步骤。

• 支持绑定接口，接口发生变化时，自动更新测试用例。

• 支持自动生成测试报告

在API 自动化测试平台中，所有的测试用例都是以项目维度来进行管理，一个自动化测试项目可以从多个API文档项目中引用API信息来创建API测试用例。

进入 API自动化测试 项目列表页，点击添加按钮：

 

在弹窗中输入相应的信息，点击确定即可：

 

在创建项目时，您也可以指定一位空间内的成员成为该项目的初始管理员，他能够帮助您进行项目内的人员权限管理工作，如绑定空间内的成员到该项目，或者修改某个成员的操作权限等。

 

五、团队管理模块：

在团队协作这方面，ApiKit 拥有成熟的 团队权限 和 项目权限 管理，支持管理员、普通成员、只读成员等角色设置，满足各类企业的需求。团队权限指成员对团队操作的权限，项目权限指成员对项目操作的权限。

点击页面左上角功能菜单，在下拉菜单中选择要切换的工作空间。

 

点击创建/加入，在引导页面中选择创建工作空间，填写工作空间名称、域名并点击确定即可。

 

六、说在最后：

作为一款接口全周期的生产力工具、一站式接口管理平台，ApiKit 在传统软件的基础上做了不少操作优化和团队协同提效的功能，对研发人员来说，可以减少无意义的工作量和繁杂耗时的沟通成本，将时间花在能 提升自身竞争力 的地方。对企业来说，它能通过提高整体的合作效率来 为企业节约成本 ；因此，官方建议的团队协作流程是这样子的：

（1）前/后端 在 ApiKit 可视化接口设计界面上定义好项目各个接口文档的初稿

（2）前后端 一起评审，完善接口文档

（3）前端 使用根据接口文档并使用 Mock 功能自动生成 Mock 数据进入开发，无需手写mock规则

（4）后端 每次调试完一个功能就保存为一个接口用例。如开发过程中接口有变化，调试的时候就自动更新了文档，零成本的保障了接口维护的及时性。

（5）测试 在接口管理页面一键生成接口参数测试用例，并依据业务场景生成自动化测试用例，一键运行接口用例，完整测试整个接口调用流程并生成接口测试报告并分享给相关人员。

（6）前后端 都开发完之后，前端将 Mock 数据切换到正式数据进行联调，由于使用同一个接口数据源，且遵循了接口规范，联调一般会非常顺利

（7）即使 版本需求变更导致接口发生了变化，后端提交修改后，前端和测试也能实时同步到修改后的数据

（8）项目经理 通过权限设置给 研发、产品、测试、外部合作人员 分配不同的操作权限，维护了项目安全

（9）项目经理 通过各个接口的开发状态来跟进项目的进度情况，把控项目风险。

官网：

https://www.eolink.com/?utm_source=cpcs&utm_content=cpy12