SuperAPI AI 工具集

rest

编程与开发

查看项目

更新于 10-16 03:43

技能介绍

用途:该技能用于指导开发者按照行业最佳实践设计 RESTful API,覆盖从资源命名到响应结构的完整设计规范。

主要能力:梳理 HTTP 方法语义(GET/POST/PUT/PATCH/DELETE/HEAD/OPTIONS 的幂等性、安全性与请求响应体);列出常用状态码含义(2xx 成功、4xx 客户端错误、5xx 服务端错误);给出资源设计示例,集合、实例、嵌套资源(最多两级)及 CRUD 不适用时的动作型接口;提供响应封装结构含 data 与 meta;错误响应遵循 RFC 7807;分页支持 offset 与 cursor 两种方式,并推荐 cursor;支持过滤、排序、字段选择与关联嵌入;缓存使用 Cache-Control、ETag、Last-Modified、Vary 等头;附 Vitest 与 supertest 单元测试模板;另含故障排查表与质量检查清单。

使用方式:作为设计参考与评审依据,按资源设计、方法与状态码、分页过滤、缓存与错误格式、测试等模块逐项核对接口。

适用场景:RESTful API 的规划、评审与测试;前后端接口约定统一。

限制:资料未提供具体运行时依赖、安装命令、收费或价格、平台支持及效果数据;除文中给出的测试模板与命令外,未提供可执行安装步骤;嵌套资源层级与动作接口为建议性质,未说明强制约束。