用途:该技能帮助按照项目模式设计并实现 REST API 端点,使用 Zod 进行校验,并维护 OpenAPI 文档。适用于新建 Next.js App Router 的 REST 端点、用 Zod 设计请求/响应 schema、实现错误处理与状态码、添加限流与认证、生成 OpenAPI 文档。不适用于 GraphQL、Cloudflare Workers、Supabase Edge Functions 以及 WebSocket/实时 API。
主要能力:提供标准路由模板,包含 schema 定义、限流配置与 GET/POST 处理器;覆盖 Zod 基础与进阶用法(枚举、数组、可空、判别联合、refine、transform、preprocess);查询参数校验;统一错误响应格式;HTTP 状态码对照;OpenAPI 文档片段;动态路由、分页等模式。
使用方式:在 src/app/api/ 下按功能分目录组织路由,如 auth、check-in、chat、journal、admin、health。路由文件内先用 z.object 定义 RequestSchema、ResponseSchema;用 createRateLimiter 配置窗口与最大请求数;处理器中依次做会话校验、限流检查、body 解析与 safeParse 校验,再查询或写入数据库,并按需记录审计日志。添加端点时同步更新 docs/openapi.yaml。
限制:资料面向 Next.js App Router 与 Zod 技术栈,涉及数据库、认证与限流的具体实现依赖项目自身模块;其他范式或平台需改用对应方案。本文未提供安装命令、收费与价格信息。