SuperAPI AI 工具集

agent-api-designer

编程与开发

查看项目

更新于 10-16 22:15

技能介绍

用途

agent-api-designer 是一个专家子代理,专门负责设计符合最佳实践的 REST 与 GraphQL API。根据其描述,适合在以下场景使用:创建新的 API、审查已有 API 设计,或编写 OpenAPI 规范。

主要能力

REST API 设计原则

资源命名方面:使用名词而非动词(如 /users 而不是 /getUsers)、使用复数形式(/users、/orders)、支持层级结构(/users/{id}/orders)、保持一致的命名约定。

HTTP 方法方面,资料给出了方法、用途与幂等性的对照表:GET 用于检索且幂等;POST 用于创建且非幂等;PUT 用于替换且幂等;PATCH 用于更新且非幂等;DELETE 用于删除且幂等。

状态码方面包含:200 OK(成功)、201 Created(资源已创建)、204 No Content(成功且无响应体)、400 Bad Request(客户端错误)、401 Unauthorized(需要认证)、403 Forbidden(无权限)、404 Not Found(资源不存在)、409 Conflict(状态冲突)、422 Unprocessable(校验失败)、500 Internal Error(服务器错误)。

响应格式采用统一结构,包含 data 数据体、meta 元信息(如 page、perPage、total 分页数据)与 links 链接(如 self、next)。错误格式同样结构化,包含 error.code(如 VALIDATION_ERROR)、error.message 以及 error.details 字段级错误列表(如 field 为 email、message 为 Invalid email format)。

GraphQL 设计原则

Schema 设计:清晰的类型定义;默认可空,显式声明非空;mutation 使用输入类型;分页使用连接(Connection)模式。

查询设计:避免过度获取;使用片段(fragments)实现复用;使用 DataLoader 解决 N+1 问题。

OpenAPI 规范

可生成完整的 OpenAPI 3.0 规范,包含:路径定义、请求/响应 Schema、认证方案、示例值、错误响应。

API 文档

文档内容涵盖:入门指南、认证流程、限流细节、版本策略、代码示例(curl、JS、Python)、变更日志。

安全考量

涉及:认证(JWT、OAuth、API 密钥)、限流、输入验证、输出过滤、CORS 配置。

使用方式

该子代理通过任务参数 $ARGUMENTS 接收具体任务指令,即以子代理形式被调用并执行给定的 API 设计任务。其调用方式与接入细节暂未提供。

适用场景

适用于需要设计新 REST 或 GraphQL API、对既有 API 设计进行审查、编写 OpenAPI 3.0 规范或完善 API 文档与安全策略的开发工作。

限制

资料未提供该子代理的运行环境要求、支持的模型、收费方式、具体安装步骤与版本信息,暂未提供。