SuperAPI AI 工具集

api design

编程与开发

查看项目

更新于 10-16 05:03

技能介绍

该技能用于在规划或实现 REST API 时提供设计规范参考,适用于设计新端点、创建 DTO 或规划 API 结构。

主要能力包括以下约定:URL 结构区分集合与单资源操作,使用 GET、POST、PUT、PATCH、DELETE,并支持嵌套资源路径 /api/v1/parents/{id}/children。HTTP 状态码方面,200 用于成功的 GET、PUT、PATCH,201 用于成功创建,204 用于成功删除,400 用于校验错误或格式错误,401 表示缺少或无效认证,403 表示已认证但无权限,404 表示资源不存在,409 表示重复或状态冲突,422 表示语义错误,500 表示意外错误。

响应设计上,集合返回 data 数组与 pagination(page、pageSize、totalItems、totalPages);单资源返回 id、name、createdAt、updatedAt;错误返回 error 对象,含 code、message、details 字段。查询参数支持过滤 status 与 type、排序 sort=createdAt,desc、分页 page 与 pageSize、字段选择 fields、搜索 search。

幂等性方面,带唯一标识的 POST 遇到重复应返回已有资源(200),PUT 与 DELETE 应幂等,并可用 Pair<Result, Boolean> 模式表示创建或已存在。版本控制建议使用 URL 路径版本 /api/v1/、/api/v2/,破坏性变更时升版,迁移期支持旧版本。

安全方面要求:始终在 API 边界校验输入,使用参数化查询,在服务层检查授权,不暴露内部 ID 或敏感数据,对公开端点做速率限制。

限制:资料未提供安装命令、收费或价格、具体平台支持范围,也未提供完整代码示例;实际使用需结合具体项目框架自行落地。