SuperAPI AI 工具集

api-design-framework

编程与开发

查看项目

更新于 10-15 19:57

技能介绍

用途:在设计新 API 端点或服务、制定团队 API 约定、评审 API 设计、迁移或版本化现有 API、编写 OpenAPI/AsyncAPI 文档,以及在 REST、GraphQL、gRPC 之间选型时提供指导。

主要能力:给出 REST 资源命名(复数名词、层级关系、kebab-case)、HTTP 方法与状态码、统一错误响应格式、游标与偏移分页、过滤排序与字段选择、URI/Header/查询参数三种版本策略、限流响应头、Bearer/API Key 认证等约定;GraphQL 方面涵盖可空性、Connection 分页、Input 类型与字段级错误;gRPC 方面涵盖 proto 结构、服务与消息定义、状态码映射。还包含 OpenAPI 3.1 与 AsyncAPI 3.0 文档结构、HATEOAS、幂等键、批量操作、Webhook 等最佳实践,以及常见反模式。

使用方式:作为技能在智能体工作流中调用,供后端架构、前端开发、代码质量评审等角色参考;资料提到可参考 /templates/openapi-template.yaml 与 /templates/asyncapi-template.yaml 模板。

适用场景:新建或重构 API、统一组织接口规范、评审接口一致性、生成接口文档。

限制:资料未提供具体安装命令、收费方式、平台支持范围或实际效果数据;内容为设计指导,不包含可直接运行的完整实现代码。