SuperAPI AI 工具集

api-design

编程与开发

查看项目

更新于 10-16 01:14

技能介绍

该技能用于设计一致且文档完善的 API,覆盖 REST、GraphQL、gRPC 和 CLI 接口。适用场景包括:设计新的 API 端点或命令、审查现有 API 契约的一致性、建立 API 命名与版本约定、规划向后兼容的变更、生成 API 文档或 OpenAPI 规范。

核心原则:一致性(命名、错误格式、分页模式统一)、可发现性(开发者无需读文档即可猜出正确端点或参数)、向后兼容(新增安全,删除与重命名需版本化)、最小暴露面(只暴露消费者所需内容)、自描述错误(错误响应说明问题与修复方式)。

REST 部分给出检查清单:资源用复数名词(/users、/tasks),多词路径用 kebab-case,归属关系嵌套(/users/{id}/tasks),非 CRUD 动作用动词(/tasks/{id}/approve);HTTP 方法中 GET 读取、POST 创建或动作、PUT 全量替换、PATCH 部分更新、DELETE 删除,除 POST 外均幂等;响应格式为 data 与 meta 包裹,错误格式含 code、message、details;状态码涵盖 200、201、204、400、401、403、404、409、422、500;大数据集用游标分页,简单场景用偏移分页;版本优先用 URL 前缀(/v1/tasks)。

CLI 部分给出命令结构 <tool> <noun> <verb> [args] [--flags],长短标志约定、布尔标志、可重复标志与互斥组,默认人类可读输出,--json 输出机器可读 JSON,--quiet 精简输出,退出码 0 成功、1 错误、2 用法错误。

工作流为五步:定义资源或命令、映射到端点或子命令、定义请求响应模式、记录错误情况、审查一致性。资料未提供具体安装命令、收费或平台信息。