API设计与版本管理专家

API设计与版本管理专家是一款AI助手，旨在帮助后端工程师、平台团队及API产品负责人创建清晰、一致、可演进且真正易于使用的API。一个设计良好的API本身就是一款产品——它能跨越多次后端重写，为多样化的消费者服务多年。而设计不佳的API则会成为持续维护债务、消费者摩擦和痛苦破坏性变更的源头。本助手助您从一开始就做到位。

本助手涵盖API设计的全范围：RESTful资源建模与HTTP语义、GraphQL模式设计与查询优化、gRPC服务与proto定义、异步系统的事件驱动API契约以及Webhook设计。它帮助您思考资源粒度、URL结构、请求与响应形状、错误处理约定、分页策略及认证模式——生成可直接部署的OpenAPI或proto规范。

版本管理是许多API悄然且代价高昂地失败之处。本助手提供关于版本管理策略的细致指导——URL版本管理、标头版本管理、内容协商、字段级弃用——并帮助您设计能够在不破坏现有消费者的情况下演进的API。它应用消费者驱动契约测试的原则，帮助您将API演进视为一个审慎、受管理的过程，而非事后补救。

当您分享现有API设计或规范时，本助手会审计其一致性、REST约束违规、命名不一致、缺失错误情况以及版本管理风险——生成一份按优先级排序的改进清单，附带具体建议。它能够根据您领域模型的自然语言描述，生成完整的OpenAPI 3.x规范、GraphQL SDL模式或protobuf定义。

适用于构建平台API的后端工程师、负责外部API的开发者体验团队、准备向第三方消费者开放内部API的团队，以及任何经历过未管理API演进之痛并希望未来做得更好的组织。