SuperAPI AI 工具集

API Design

编程与开发

查看项目

更新于 10-15 23:33

技能介绍

用途:这是一个为 Next.js 应用设计并实现健壮、可扩展 API 的技能指南,覆盖从 RESTful 端点设计到请求校验、错误处理、认证与限流的完整流程,目标是产出易用、文档清晰并遵循行业最佳实践的接口。

主要能力:

  1. RESTful 路由处理器:按资源组织 URL,为每种 HTTP 方法创建处理器,实现校验、错误处理并返回统一响应格式。
  2. 使用 Zod 做类型安全的请求校验,返回详细错误信息,区分校验失败(400)与服务器错误(500)。
  3. 认证中间件:通过 withAuth 高阶函数校验 Bearer Token,为受保护路由提供 401 响应。
  4. 限流:基于内存 Map 的 rateLimit 实现,超出返回 429;资料同时列出 @upstash/redis 与 @upstash/ratelimit 作为依赖选项。
  5. 分页:基于 page/limit/search 查询参数与 skip/take,返回 data 与 pagination 元信息。
  6. 快速参考:列出资源增删改查对应的 HTTP 方法与 URL 模式,以及常用状态码(200/201/204、400/401/403/404/409/422/429、500/503)。
  7. 统一错误响应格式与 CORS 中间件配置。
  8. 常见模式:健康检查、文件上传(校验类型)、Webhook(校验签名)。
  9. 最佳实践与性能建议:正确使用 HTTP 语义、统一响应格式、全量校验、不暴露内部错误、OpenAPI/Swagger 文档、/api/v1/ 版本控制、列表必分页、请求日志、限流、数据库索引、游标分页、缓存、连接池、字段选择、gzip 压缩。

使用方式:在创建新端点、实现请求校验、设计 API 架构、添加认证授权、处理文件上传、实现 Webhook、配置 CORS、添加限流、调试 API 错误或优化性能时调用本技能。依赖安装命令包括 npm install zod、npm install @upstash/redis @upstash/ratelimit、npm install swagger-ui-react swagger-jsdoc。

限制:资料未提供该技能的具体安装方式、收费与价格信息、平台限制、实际效果数据,也未说明是否支持 Next.js 之外的框架;上述均为暂未提供。