SuperAPI AI 工具集

api-designer

编程与开发

查看项目

更新于 10-16 03:12

技能介绍

用途:该技能面向 API 设计与文档编写,按行业常见实践创建结构清晰的 RESTful 接口,并产出 OpenAPI 3.0 及以上规范。可通过 /api-design 命令触发,也适用于用户提出 API 设计、文档或需要 OpenAPI/Swagger 规范的场景。

主要能力:分析需求(需暴露哪些资源、需要哪些 CRUD 或自定义操作、认证要求、数据关系);设计端点,采用 /api/v1/ 版本化路径与复数名词集合命名,如 GET/POST /api/v1/users、GET/PUT/DELETE /api/v1/users/{id};定义请求与响应 JSON Schema(含 uuid、email、date-time 等格式与 required 字段);生成 OpenAPI 规范并输出接口文档。

设计原则:面向资源而非动作;命名一致;正确使用 HTTP 方法(GET 读、POST 建、PUT 改、DELETE 删);使用 200、201、400、404、500 等状态码;URL 路径中带版本;支持 limit/offset 或游标分页;允许查询参数过滤。错误响应采用统一结构,包含 error.code、error.message 与 details 字段列表。

兼容性:Codex 与 Claude Code 均支持。安装与收费信息资料未提供。