用途:为 Next.js App Router 项目建立一致的 REST API 约定,覆盖资源命名、HTTP 方法、URL 结构、目录组织、响应格式与错误处理,并配合 Zod 做类型安全校验。
主要能力:资源名用复数(如 /api/projects);GET 读取、POST 创建、PATCH 局部更新、PUT 全量替换、DELETE 删除;URL 支持集合、单项与嵌套资源(如 /api/projects/123/tasks)。目录按 src/app/api/{resource}/route.ts 与 [id]/route.ts 组织,公共工具放在 _lib 下的 errors.ts、validation.ts、response.ts。成功响应统一为 { data } 或 { data, meta },错误响应为 { error: { code, message, details } }。提供 validationError、notFound、unauthorized、forbidden、conflict、internalError 等错误工具,以及 parseBody、parseQuery、paginationSchema、idParamSchema 等校验辅助。状态码约定 200/201/204/400/401/403/404/409/500。
使用方式:在 API 路由中先做会话鉴权,再用 parseBody 或 parseQuery 校验输入,失败返回 validationError;查询支持过滤、排序、搜索与分页(page、pageSize,meta 返回 total、page、pageSize);列表与单项路由分别实现对应方法,删除成功返回 204 无正文。可从 Zod schema 导出类型供前端复用。
适用场景:Next.js App Router 中新建 API 路由、实现 CRUD、设计资源端点、统一错误与校验模式。
限制:资料未提供具体安装命令、依赖版本、收费与平台信息;示例使用 Drizzle ORM 与 auth,实际项目需按自身技术栈调整。