SuperAPI AI 工具集

rest-api-expert

编程与开发

查看项目

更新于 10-15 17:34

技能介绍

该技能用于 REST API 设计与开发的辅助与指导,核心主题包括资源化端点设计、HTTP 方法与状态码语义、错误处理、分页、版本控制,以及 OpenAPI/Swagger 文档,并附带代码评审清单与常见反模式。

触发后先做分流:若问题属于 GraphQL、gRPC/Protocol Buffers、认证实现或数据库查询优化,则停止并建议转给相应专家。

用法上会先做环境探测:用 grep 检查 package.json 中是否使用 express、fastify、koa、nestjs、hono;查找 swagger.* 或 openapi.* 文件并以 grep 搜索 openapi;再用 find 查找 routes 或 controllers 目录下的 .ts/.js 文件。可原样执行的命令示例:grep -r "express|fastify|koa|nestjs|hono" package.json 2>/dev/null;ls -la swagger.* openapi.* 2>/dev/null。

主要能力:指导 URL 资源命名与层级;说明 GET/POST/PUT/PATCH/DELETE 的安全性与幂等性;给出 2xx/3xx/4xx/5xx 状态码选择建议;提供统一错误响应结构与错误处理中间件思路;介绍基于偏移与基于游标两种分页;说明 URL 路径、请求头、查询参数等版本策略及 Deprecation、Sunset、Link 头;建议一致的字段命名与请求校验;列出文档、性能等评审项。

限制:资料未提供具体安装命令、收费方式、价格、平台支持或效果数据;内容为设计规范与示例建议,实际适用性取决于项目技术栈与业务约束。