
而在研发全生命周期管理之中,API 管理的地位愈发显得重要。随着 API 数量的大幅增长,也带来了新的 API 管理需求。
1、DevOps 中 API 管理困境
在实际的 DevOps 工作流中,API 管理面临着以下 6 大方面的困境:规范、协作、自动化质量、迭代、自动化。
困境一:规范落地执行难
针对这个困境,可以通过统一的 API 管理平台规范文档的模板,引导编写流程和习惯,也可以通过自动化文档管理工具来简化流程,提高管理效率。
困境二:岗位协作难、信息沟通效率低
针对这个困境,可以缩短流程环节,多启用自动化流程。同时制定精细化通知规则,根据优先级提供差异化通知样式。最后,再通过每日推送复盘消息,梳理当日工作项和消息通知,防止遗漏。
困境三:自动化测试体系搭建门槛高
针对这个困境,可以使用界面化的自动化测试工具,降低脚本编写门槛。还可以通过一站式 API 全生命周期管理平台,免去大量前期工作,提高自动化测试效率。
困境四:API 生产质量和在线异常的发现、跟踪、解决流程过长
可以通过一体化的 API 管理工具来打通不同环节的工作流,提高研发质量和效能。
困境五:接口文档无法跟踪迭代版本,回溯排查难度大
接口文档作为研发项目的重要资产,应该对其变更进行盘点,包括提供接口文档的历史记录。可以通过一站式 API 全生命周期管理工具,提供项目级的接口版本管理和接口迭代计划,输出更加优质的接口文档,推进 DevOps 工作流的效率提升。
困境六:DevOps 工作流使用工具多
针对这个问题,可以使用一体化的 API 全生命周期管理工具来实现与接口相关的所有问题,减少对接的工具数量。
2、DevOps 中 API 管理需要什么
-
规范化: 一个可配置规范、可自动根据规范生成 API 文档的 API 规范工具
- 高协作: 一个接口相关状态自动流转、精准通知信息的 API 协作工具
- 自动化: 一个低门槛、智能录入数据的 API 自动化测试工具
- 高质量: 一个一站式接口全流程质量管理的 API 测试工具
- 迭代快: 一个提供从项目级迭代计划,版本管控,到接口级历史记录的 API 管理工具
- 工具链: 一个接口全生命周期且多种对外集成方式的 DevOps 工具
API 全生命周期智能协作平台。在这个一体化平台上,可以从 API 的开发态到发布态到运营态,对 API 进行全生命周期管理。
3、API 全生命周期如何接入 DevOps
计划、开发、构建、测试、部署、发布、运维跟监控环节,探讨 API 管理工具对接。
3.1 计划:制定 API 文档规范,搭建层次清晰的 API 仓库
- 根据公司组织架构和系统服务的分布,组成一个层次清晰的接口仓库。
- 统一规范制定,把不同团队的规范统一制定成公司的规范。
- 整理公共材料,把历史文档快捷地导入到 API 仓库里,以及把一些可复用的材料例如经常用的数据结构,API 文档的模板、常用字段描述,都可以存储到 API 仓库,以便于在开发阶段创建新的 API 文档。
3.2 开发:基于代码仓库搭建自动化流程,解决前后端调试和沟通问题
3.3 构建:自动打接口版本及自动冒烟测试,支持回滚和减轻测试工程师压力
这两个步骤可以让测试对任务进行评估,更好地去减轻测试的压力。目前接口上自动化能测出来的问题,可预先通过 API 测试出来。
3.4 测试:推进自动化测试,降低用例编写成本
也可以基于 API 网关的监控日志做流量回放,自动生成自动化测试用例,识别增量接口并跑模糊测试。可以组成场景案例,做回归测试。模糊测试跟回测试的测试结果发送测试报告,给到对应的测试人员。
3.5 部署:快速测试核心流程,排除环境差异问题
注:目前 Eolink Apikit 压力测试功能将在年中上线,敬请期待!
3.6 发布:确保对外访问畅通和安全
3.7 运维:保障服务持续稳定和安全
3.8 监控:实时观察接口运行情况,及时异常告警
4、不同规模团队如何落地实施
4.1 大规模团队:全 DevOps 周期的接口自动化
接下来在 CD 环节部署好服务之后,可以对环境进行预测试,并根据需求做压力测试,并把测试报告发送给对应的相关人员。除了 CICD,还可以集成 Eolink 的网关产品,对 API 进行运维管理。
4.2 小规模团队:高性价比的接口自动化
目前该高性价比解决方案,已覆盖从设计、开发到构建、发布、部署的环节,对运维、监控、压力测试等环节尚且缺失,对于核心的 API 全自动化的管理流程已完全足够。
5、总结
API 全生命周期管理平台 Eolink Apikit 是结合 API 设计、文档管理、自动化测试、监控、研发管理和团队协作的一站式 API 研发协作平台,是 API 研发管理最佳实践产品,可以帮助个人开发者到跨国企业用户,快速、规范地对 API 进行全生命周期管理,提高研发效能。