一、API接口维护痛点

    我们在API接口实现和维护中,经常遇到的痛点就是文档与接口实现不一致的问题。这样的根因主要是接口代码定义与接口文档分开维护导致的,例如:

    • 接口代码定义在代码项目中,但是接口文档由另外的独立接口文档平台维护。费时费力的同时,容易引起两边不一致,增加协作成本。
    • 接口代码定义和接口文档都是在代码项目中维护,但是接口文档由独立的模块或者注释维护,也容易造成接口代码定义与文档不一致。

    2、多种接口协议下,维护方式不统一

    能否只采用一套统一且便捷的API定义方式,支持不同的接口协议?

    拿到gRPC/Thrift协议定义后怎么做呢?使用对应的工具生成对应Client SDK再使用?

    二、API接口维护改进

    1、统一化维护接口定义

    3、抓大放小,专注核心痛点

    5、支持多种协议的客户端SDK生成