SuperAPI AI 工具集

api-design

编程与开发

查看项目

更新于 10-16 01:18

技能介绍

用途:为 fullstack-dev 团队提供 API 设计规范,统一接口风格与错误处理方式。

主要能力:REST 约定方面,资源使用复数名词(/users、/posts、/comments),正确使用 HTTP 方法(GET 读取、POST 创建、PUT 替换、PATCH 更新、DELETE 删除),支持嵌套子资源(/users/:id/posts),用查询参数过滤(/posts?status=published&author=123),并返回恰当状态码(200、201、204、400、401、403、404、409、422、500)。响应结构统一为 data、error、meta 三段,其中 meta 可含分页信息(如 page、total)。错误响应中 error 包含 code、message 与 details,details 可给出字段级错误(如 email 格式无效)。输入校验要求在所有 API 边界校验输入,校验失败返回 422 并附字段级详情,对字符串做净化以防注入,并对所有输入强制大小限制。认证方面,使用项目现有认证机制,在路由层应用认证中间件,缺少或无效凭证返回 401,权限不足返回 403。版本化方面,遵循项目现有版本策略;若不存在,优先使用 URL 路径版本化,如 /api/v1/resource。

使用方式:作为团队开发规范参考,在编写或评审 API 时对照执行。资料未提供具体安装命令或调用示例。

适用场景:全栈开发团队设计 REST API、统一响应与错误格式、处理校验与认证授权、规划接口版本。

限制:资料未说明该技能的具体运行环境、依赖、安装方式、收费情况或与其他工具的集成细节,这些信息暂未提供。