SuperAPI AI 工具集

api-design

编程与开发

查看项目

更新于 10-16 00:29

技能介绍

用途:在构建或修改 API 端点时主动加载,指导 REST 路由、GraphQL resolver、tRPC procedure 及任意 HTTP 端点的设计与实现;触发短语包括“create an API”“build endpoint”“implement route”“add validation”等。

主要能力:按阶段推进。发现阶段用 get_api_routes 摸清路由位置、HTTP 方法、框架模式,用 discover 检索中间件、校验、错误处理与认证模式,并用 precision_read 阅读代表性路由文件。决策阶段参照 references/api-style-guide.md 在 REST、GraphQL、tRPC、Server Actions 间选择。实现阶段先用项目校验库定义 schema(如 Zod),再写路由处理器或 tRPC 过程,并用 precision_write 落盘路由、schema 与类型。随后统一错误响应格式,给出 HTTP 状态码指引,并用 generate_openapi 生成文档、以 sync_api_types 检查前后端类型一致性。最后用 validate_api_contract 校验契约、precision_exec 运行 npm run typecheck、bash scripts/api-checklist.sh . 执行检查清单。

适用场景:新增路由、请求校验与中间件、错误格式设计、API 文档生成、类型同步、API 范式迁移。

限制:具体命令、工具名与代码示例以资料为准;不同框架的适配细节需查阅 references/api-style-guide.md。文档未提供该技能的安装方式、收费或平台支持信息,暂未提供。