ruan-cat Nitro v3 接口开发
核心依赖
pnpm add nitro
导入规范 [CRITICAL]
// 必须从 nitro/h3 导入
import { defineHandler, HTTPError, readBody, getQuery, getRouterParam } from "nitro/h3";
import type { H3Event } from "nitro/h3";
// 使用项目工具函数
import { defineApiHandler, badRequest, notFound } from "../utils/api";
基础接口模板
/**
* @file 用户列表接口
* @description GET /users
*/
import { defineApiHandler } from "../utils/api";
export default defineApiHandler(
async () => {
return await db.select().from(usersTable);
},
{ errorMessage: "获取用户列表失败" },
);
常见错误对比
| 错误写法 | 正确写法 |
|---|---|
import { ... } from "h3" |
import { ... } from "nitro/h3" |
import { createError } from "..." |
import { HTTPError } from "nitro/h3" |
defineEventHandler |
defineHandler 或 defineApiHandler |
createError({ statusCode: 400 }) |
new HTTPError({ status: 400, ... }) |
详细参考
- 完整目录结构：参阅 reference.md
- 公共类型定义：参阅 reference.md
- 工具函数：参阅 reference.md
- 接口模板：参阅 reference.md
- 配置与部署：参阅 reference.md
- 函数速查表：参阅 reference.md