SuperAPI AI 工具集

api-design

编程与开发

查看项目

更新于 10-15 21:35

技能介绍

用途:在设计或修改 REST API 端点、控制器结构、路由模式、请求/响应 DTO 时使用,目标是让接口遵循项目平台模式与 REST 最佳实践。

主要能力:提供路由命名约定表(列表 GET /api/{resource}、按 ID 获取 GET /api/{resource}/{id}、创建/更新 POST /api/{resource}、删除 DELETE /api/{resource}/{id}、复杂搜索 POST /api/{resource}/search、自定义动作 POST /api/{resource}/{id}/{action}、嵌套资源 GET /api/{parent}/{id}/{child});给出文件上传端点写法([HttpPost("upload")]、[RequestSizeLimit(50 * 1024 * 1024)]、UploadCommand 继承项目 CQRS 基类);说明框架自动处理的错误响应格式(validation 400、business 422);并提供 API 设计检查清单(RESTful 命名、HTTP 方法、授权特性、校验位置、响应格式一致性、列表分页、错误处理)。

使用方式:工作流分为设计(按 RESTful 约定定义路由)、实现(创建控制器与 CQRS 命令/查询,含校验与授权)、验证(运行 API 设计检查清单)三步。实现前需阅读项目参考文档 docs/project-reference/backend-patterns-reference.md,并查看 docs/project-config.json 的 api 段(style、authPattern、docsFormat)。在 Codex 中以 $skill-name 调用仓库技能。

关键规则:遵循项目基础控制器与 CQRS 模式;路由使用 /api/{resource}(复数、小写、无动词);校验放在 Command/Query 的 Validate() 而非控制器;始终添加授权特性;控制器保持轻薄,业务逻辑放在处理器中。

反模式:URL 中出现动词、缺少授权、在控制器中做校验、在控制器中写业务逻辑、命名不一致。

限制:资料未提供该技能的具体安装命令、收费方式、支持平台与效果数据;其内容依赖项目自身的参考文档与配置,缺失时需先查找项目文档、编码规范与架构文档。