会员接口治理的探索与实践

爱

会员技术团队2022年12月02日约 4 分钟

随着爱奇艺会员破亿，会员服务从小而快的单一业务系统升级为了按领域划分的微服务模式，满足了业务的高速发展和服务的高流量调用，但是微服务的拆分，系统间的交互越来越多，在需求开发时，协作成本随之增加，问题总结如下：

历史包袱过重，接口管理工具不统一：WIKI、YAPI、Swagger
接口维护成本高，代码和文档需要同时更新
接口联调和测试成本高，由于环境、链路导致的问题，排查难度大，业务复杂的需求可能会延期

基于以上问题，会员团队需要一个平台把接口管控起来，提升研发和测试的效率。

方案调研

比较了现有平台（见下图），都不能满足会员的需求，但是Atlas是公司内部开发的平台，已经有接口管理的基础能力，可以共同开发，在平台上扩展会员需要的功能：代码即文档、一键链路排障、接口规范统一管控、签名和实体自动生成，不仅可以解决会员的痛点，还可以为公司其他部门赋能，避免了重复造轮子。

Atlas 是一个基于接口管理的业务知识管理平台，提供了统一的接口管控入口、接口规范（OpenAPI3.0）、接口调试和 mock、链路定位、关系图谱等能力，有效地解决了接口文档管理、分享和协作相关的问题。

项目目标

简化开发

Atlas 让前后端数据交互更简单，让团队开发协作更容易。前端同学无需依赖后端开发进度，直接借助 mock 功能即可实现联调。

智能文档

实现代码即文档、文档即代码，文档自动同步代码改动，让文档维护更智能。

高效协作
支持强大的联调、链路问题定位、代码自动生成等功能，前后端协作更高效。支持自动化的依赖分析，各关联方通过订阅方式，可以及时、准确地把握接口变更，通过图谱可以全面掌握影响范围。

解决方案

01 一键验证

基于全链路监控系统打通了环境平台内部的链路，实现了在开发和测试阶段可以一键定位环境和调用链路问题的能力，极大减少了研发和测试的排查时间。一键验证功能目前已覆盖了异步任务、RocketMQ 和 API 接口的问题排查。通过下图所示的排查链路，可快速定位异常服务和问题原因。

架构设计如下：

02 知识图谱

系统依赖日趋复杂，研发需要了解自己所开发接口的依赖与被依赖关系，才能保证版本迭代时上下游不受影响。测试需要了解自己所测接口的上下游依赖关系，才能保证 case 覆盖率。为了让这种依赖关系展示的全面、具体，我们使用全链路监控系统自动获取了接口级、字段级的依赖关系，并借助 G6 以图谱的方式展示在 Atlas 上。