SuperAPI AI 工具集

atelier-typescript-api-design

编程与开发

查看项目

更新于 10-16 00:06

技能介绍

用途:为 REST API 设计提供与框架无关的规范,适用于设计端点、错误响应、分页、版本控制与整体 API 结构。

主要能力:资源命名采用复数名词、小写加连字符,嵌套最多两层,动词仅用于 activate、publish、send 等非 CRUD 动作;版本放在 URL 路径(/api/v1/、/api/v2/),不放在请求头或查询参数;错误响应遵循 RFC 7807 Problem Details,包含 type、status、title、detail、instance、traceId,并给出 AppError 基类及 NotFoundError、ConflictError、ServiceUnavailableError 等具体错误类型;分页推荐游标方式,请求带 limit 与 cursor,响应返回 items、nextCursor、hasMore,实现时多取一条判断 hasMore;过滤与排序通过查询参数完成,排序用 - 前缀表示降序;HTTP 状态码区分 200、201、204、400、401、403、404、409、422、429、500、503;时间戳统一使用 ISO 8601 与 toISOString();非幂等操作(POST、PATCH)使用 Idempotency-Key 请求头实现安全重试;简单 CRUD 不套响应信封,分页时才使用信封承载元数据。

使用方式:作为设计参考与代码约定,按上述模式编写路由、错误类与分页查询;错误处理细节可参考 references/error-responses.md。

适用场景:需要统一 API 风格、错误格式与分页策略的后端服务设计。

限制:资料未提供具体安装命令、依赖版本、收费信息或平台支持范围,暂未提供。