随着DevOps理念在中国企业当中的普及和发展,中国企业DevOps落地成熟度不断提升,根据中国信通院的数据已有近6成企业向全生命周期管理迈进。而在研发全生命周期管理之中,API管理的地位愈发显得重要。随着API数量的大幅增长,也带来了新的API管理需求。如何在DevOps工作流中进行API全生命周期管理,对项目研发来说具有重大意义。
在实际的DevOps工作流中,API管理面临着以下6大方面的困境:规范、协作、自动化质量、迭代、自动化。
因为团队中的API文档质量参差不齐,导致规范很难落地执行。原因在于公司有很多的研发项目和团队,不同的团队有不同的API管理习惯,尤其是常用的Swagger方式的管理,很难进行统一的平台化管理。针对这个困境,可以通过统一的API管理平台规范文档的模板,引导编写流程和习惯,也可以通过自动化文档管理工具来简化流程,提高管理效率。
在DevOps工具链中,每一个工具都会有不同的通知消息,导致重要信息淹没在繁杂的通知中。其次是工作流程环节多、流程长,各岗位角色处理工作节奏不一,导致任务链上下游沟通效率低。针对这个困境,可以缩短流程环节,多启用自动化流程。同时制定精细化通知规则,根据优先级提供差异化通知样式。最后,再通过每日推送复盘消息,梳理当日工作项和消息通知,防止遗漏。
传统的自动化接口测试脚本需要用Python/ target=_blank class=infotextkey>Python来编写,门槛高,成本高。又因纯手工编写,开发变动后还须对照文档二次调整接口的所有脚本。另外,自动化测试前期投入时间多,准备工作繁杂。针对这个困境,可以使用界面化的自动化测试工具,降低脚本编写门槛。还可以通过一站式API全生命周期管理平台,免去大量前期工作,提高自动化测试效率。
当下,在后端的接口自测、前段的MOCK测试、冒烟测试、集成测试、异常监控这5个环节中都会使用到不同的工具,于是产生了跨工具之间对接复杂、数据隔离,导致API生产质量薄弱,以及大量重复工作。可以通过一体化的API管理工具来打通不同环节的工作流,提高研发质量和效能。
传统的接口管理工具如Swagger没有接口修改记录,缺少版本管理,无法通过日志定位问题,无法进行回滚和历史对比。另外团队也缺少接口迭代计划,导致开发量和影响面分析都难以评估。接口文档作为研发项目的重要资产,应该对其变更进行盘点,包括提供接口文档的历史记录。可以通过一站式API全生命周期管理工具,提供项目级的接口版本管理和接口迭代计划,输出更加优质的接口文档,推进DevOps工作流的效率提升。
DevOps作为宏观层面的研发管理思路,目前并没有大而全的工具,因此带来企业内部工具越积越多,数据流通阻滞,另外,传统接口管理工具功能也很单一。针对这个问题,可以使用一体化的API全生命周期管理工具来实现与接口相关的所有问题,减少对接的工具数量。
基于前文对DevOps中API管理存在的问题,可以梳理出企业R&D需要以下六个方面:
对于满足这些条件的工具,我们定义为API全生命周期智能协作平台。在这个一体化平台上,可以从API的开发态到发布态到运营态,对API进行全生命周期管理。
平台地址:https://www.eolink.com/apikit?utm_source=mo04sssjsh。
根据经典的DevOps流程图,我们从计划、开发、构建、测试、部署、发布、运维跟监控环节,探讨API管理工具对接。
基于代码仓库或swagger或本地研发工具,快速自动生成API文档并快速调试,调试没问题后再自动生成 MOCK API和批量接口用例,可以在线分享给前端和测试,文档支持在线评论。最终还可以基于这个 API 文档生成业务代码,协助开发。
构建阶段可以基于 CI 触发器自动构建接口版本,方便后续版本回滚,还可基于接口版本做批量测试,以及做版本差异化的对比。
这两个步骤可以让测试对任务进行评估,更好地去减轻测试的压力。目前接口上自动化能测出来的问题,可预先通过API测试出来。
在测试阶段我们推荐自动化测试,一体化API全生命周期管理工具可以去快速同步前面开发阶段生成的测试用例,然后对这些测试用例进行流程编排,组成自动化测试用例。也可以基于 API 网关的监控日志做流量回放,自动生成自动化测试用例,识别增量接口并跑模糊测试。可以组成场景案例,做回归测试。模糊测试跟回测试的测试结果发送测试报告,给到对应的测试人员。
部署之后可以通过 CD 触发器对环境进行预测,试跑核心的测试场景,生成对应的测试报告。可以通过多环境的测试结果进行对比,排查环境差异的问题,也可以在部署好之后进行压力测试。(注:目前Eolink Apikit压力测试功能将在年中上线,敬请期待)
在发布阶段,主要对接 API 网关,让系统可以正常对外访问,开放接口能力。
在运维阶段依然是使用 API 网关,做流量控制、负载均衡或服务治理。在接口开放上可以去做Open API 调用管控,在线试用跟鉴权。在接口交易上可以去做接口托管、转发跟计算计费以及订单管理。
可以设置标准的接口监控指标,做更加灵活的监控配置,并对告警进行规则配置预设,当满足这些告警的预设条件时就会发送消息通知,包括手机短信、主流的 IM 工具,以及webhook。
在消息通知方面,我们认为不仅仅需要DevOps主流程的对接,而是要保证整个DevOps信息流的有效和及时传递,因此需要对 API 文档的变更、测试报告、监控告警,进行智能分发。例如进行分级推送、智能归纳、高风险标记等。
【重磅】DevOps工作流对接API全生命周期管理全流程图
对于大规模团队来说,推荐基于DevOps全周期的接口自动化方案,需部署Eolink Apikit私有云版本。在这个方案中,可以把Swagger的URL自动同步到Eolink Apikit,自动生成文档,进一步基于文档生成业务代码,然后发送到代码仓库,再去触发CI流水线,给文档打版本,做模糊测试,并把报告发送给对应的人员。接下来在CD环节部署好服务之后,可以对环境进行预测试,并根据需求做压力测试,并把测试报告发送给对应的相关人员。除了CICD,还可以集成Eolink的网关产品,对API进行运维管理。
对于小规模团队来说,性价比更高的SaaS企业版,可以使用插件生成API文档上传Eolink Apikit,并进行测试,自动生成测试用例。
目前该高性价比解决方案,已覆盖从设计、开发到构建、发布、部署的环节,对运维、监控、压力测试等环节尚且缺失,对于核心的API全自动化的管理流程已完全足够。
本文提出使用一体化的API管理平台在DevOps工作流中对API进行全生命周期管理,解决过去多个工具之间数据隔离、流程阻滞的问题。
API全生命周期管理平台Eolink Apikit是结合 API 设计、文档管理、自动化测试、监控、研发管理和团队协作的一站式 API 研发协作平台,是API研发管理最佳实践产品,可以帮助个人开发者到跨国企业用户,快速、规范地对API进行全生命周期管理,提高研发效能。
平台地址:https://www.eolink.com/apikit?utm_source=mo04sssjsh。