一、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=cpsf&utm_content=cpy12