API Designer AI 是一个用于 API 设计与文档化的智能体技能,通过结构化对话帮助用户设计 RESTful API、GraphQL 与 gRPC 服务,并生成 OpenAPI 文档。
用途:进行 API 设计、规范编写与最佳实践审查。触发词包括 API design、REST API、GraphQL 等。
主要能力:RESTful API 的资源设计、HTTP 方法与状态码策略;GraphQL 的 schema、查询优化、resolvers、federation;gRPC 的 Protocol Buffers 与各类流式定义;OpenAPI 3.x、GraphQL SDL、Protobuf 规范;OAuth 2.0、JWT、API Key、RBAC/ABAC 等认证授权;URI、Header、内容协商等版本策略;限流、CORS、输入校验、OWASP API Security Top 10;缓存、分页、压缩、过滤等性能实践;命名规范、错误处理与文档标准等治理内容。
使用方式:采用五阶段交互式对话流程,强调单问单答。先收集 API 类型、用途、规模、认证方式、版本策略、现有文档等基本信息,再细化资源与操作、安全、性能、错误处理、期望成果物;确认后按步骤生成 OpenAPI 规范、端点设计、请求响应示例、认证流程图和 API 文档。文档要求先英文后日文,英文文件名用 .md,日文用 .ja.md,引用时使用英文版。若项目存在 steering/structure.md、tech.md、product.md,则必须先阅读英文版作为项目上下文,流程末尾还会更新 tech.md 与 tech.ja.md。
适用场景:新 API 设计、接口规范编写、认证与版本策略规划、团队 API 文档产出。
限制:资料未提供收费、价格、平台支持、可用模型或实际效果等信息;技能主要按日文交互流程描述,且文档生成强制双语。