v3.16
GitHub

server

server/ 目录用于将 API 和服务器处理程序注册到您的应用程序中。

Nuxt 自动扫描这些目录中的文件，以注册带有热模块替换 (HMR) 支持的 API 和服务器处理程序。

目录结构
-| server/
---| api/
-----| hello.ts      # /api/hello
---| routes/
-----| bonjour.ts    # /bonjour
---| middleware/
-----| log.ts        # 记录所有请求

每个文件应导出一个使用 defineEventHandler() 或 eventHandler()（别名）定义的默认函数。

处理程序可以直接返回 JSON 数据、一个 Promise，或使用 event.node.res.end() 发送响应。

server/api/hello.ts
export default defineEventHandler((event) => {
  return {
    hello: 'world'
  }
})

您现在可以在页面和组件中全局调用此 API：

pages/index.vue
<script setup lang="ts">
const { data } = await useFetch('/api/hello')
</script>

<template>
  <pre>{{ data }}</pre>
</template>

服务器路由

~/server/api 目录中的文件在路由中会自动加上 /api 前缀。

要添加没有 /api 前缀的服务器路由，请将它们放入 ~/server/routes 目录。

示例：

server/routes/hello.ts
export default defineEventHandler(() => 'Hello World!')

根据上面的示例，/hello 路由将在 http://localhost:3000/hello 可访问。

请注意，目前服务器路由不支持 pages 的动态路由的完整功能。

服务器中间件

Nuxt 将自动读取 ~/server/middleware 中的任何文件，为您的项目创建服务器中间件。

中间件处理程序将在每个请求上运行，以添加或检查头信息，记录请求或扩展事件的请求对象。

中间件处理程序不应返回任何内容（也不应关闭或响应请求），仅应检查或扩展请求上下文或抛出错误。

示例：

server/middleware/log.ts
export default defineEventHandler((event) => {
  console.log('新请求: ' + getRequestURL(event))
})
server/middleware/auth.ts
export default defineEventHandler((event) => {
  event.context.auth = { user: 123 }
})

服务器插件

Nuxt 将自动读取 ~/server/plugins 目录中的任何文件并将其注册为 Nitro 插件。这允许扩展 Nitro 的运行时行为并挂钩生命周期事件。

示例：

server/plugins/nitroPlugin.ts
export default defineNitroPlugin((nitroApp) => {
  console.log('Nitro 插件', nitroApp)
})
Read more in Nitro 插件.

服务器实用工具

服务器路由由 unjs/h3 提供支持，后者带有一组方便的助手。

Read more in 可用的 H3 请求助手.

您可以在 ~/server/utils 目录中自己添加更多助手。

例如，您可以定义一个自定义处理程序实用工具，包装原始处理程序并在返回最终响应之前执行额外操作。

示例：

server/utils/handler.ts
import type { EventHandler, EventHandlerRequest } from 'h3'

export const defineWrappedResponseHandler = <T extends EventHandlerRequest, D> (
  handler: EventHandler<T, D>
): EventHandler<T, D> =>
  defineEventHandler<T>(async event => {
    try {
      // 在路由处理程序之前执行某些操作
      const response = await handler(event)
      // 在路由处理程序之后执行某些操作
      return { response }
    } catch (err) {
      // 错误处理
      return { err }
    }
  })

服务器类型

此功能在 Nuxt >= 3.5 中可用

为了改善您的 IDE 中的自动导入与“nitro”和“vue”之间的清晰度，您可以在 ~/server/tsconfig.json 中添加以下内容：

server/tsconfig.json
{
  "extends": "../.nuxt/tsconfig.server.json"
}

目前，这些值在类型检查时不会被遵守 (nuxi typecheck)，但您应该在 IDE 中获得更好的类型提示。

食谱

路由参数

服务器路由可以在文件名中使用括号中的动态参数，例如 /api/hello/[name].ts，并通过 event.context.params 访问它。

server/api/hello/[name].ts
export default defineEventHandler((event) => {
  const name = getRouterParam(event, 'name')

  return `Hello, ${name}!`
})
或者，使用 getValidatedRouterParams 和一个模式验证器（如 Zod）进行运行时和类型安全。

您现在可以在 /api/hello/nuxt 上全局调用此 API，并获得 Hello, nuxt!。

匹配 HTTP 方法

处理文件名可以附加 .get、.post、.put、.delete 等后缀，以匹配请求的 HTTP 方法。

server/api/test.get.ts
export default defineEventHandler(() => '测试 get 处理程序')
server/api/test.post.ts
export default defineEventHandler(() => '测试 post 处理程序')

根据上述示例，使用以下方式获取 /test：

  • GET 方法：返回 测试 get 处理程序
  • POST 方法：返回 测试 post 处理程序
  • 任何其他方法：返回 405 错误

您还可以在目录中使用 index.[method].ts 以不同的方式结构化代码，这对于创建 API 命名空间非常有用。

export default defineEventHandler((event) => {
  // 处理 `api/foo` 端点的 GET 请求
})

捕获所有路由

捕获所有路由对于回退路由处理很有帮助。

例如，创建一个名为 ~/server/api/foo/[...].ts 的文件将为所有不匹配任何路由处理程序的请求注册一个捕获所有路由，例如 /api/foo/bar/baz。

server/api/foo/[...].ts
export default defineEventHandler((event) => {
  // event.context.path 获取路由路径: '/api/foo/bar/baz'
  // event.context.params._ 获取路由片段: 'bar/baz'
  return `默认 foo 处理程序`
})

您可以通过使用 ~/server/api/foo/[...slug].ts 为捕获所有路由设置名称，并通过 event.context.params.slug 访问。

server/api/foo/[...slug].ts
export default defineEventHandler((event) => {
  // event.context.params.slug 获取路由片段: 'bar/baz'
  return `默认 foo 处理程序`
})

请求体处理

server/api/submit.post.ts
export default defineEventHandler(async (event) => {
  const body = await readBody(event)
  return { body }
})
或者，使用 readValidatedBody 与模式验证器（如 Zod）进行运行时和类型安全。

您现在可以使用以下方式全局调用此 API：

app.vue
<script setup lang="ts">
async function submit() {
  const { body } = await $fetch('/api/submit', {
    method: 'post',
    body: { test: 123 }
  })
}
</script>
我们在文件名中使用 submit.post.ts 只是为了匹配可以接受请求体的 POST 方法请求。当在 GET 请求中使用 readBody 时，readBody 将抛出一个 405 Method Not Allowed HTTP 错误。

查询参数

示例查询 /api/query?foo=bar&baz=qux

server/api/query.get.ts
export default defineEventHandler((event) => {
  const query = getQuery(event)

  return { a: query.foo, b: query.baz }
})
或者，使用 getValidatedQuery 和模式验证器（如 Zod）进行运行时和类型安全。

错误处理

如果没有抛出错误，将返回状态码 200 OK。

任何未捕获的错误将返回 500 Internal Server Error HTTP 错误。

要返回其他错误代码，请使用 createError 抛出异常：

server/api/validation/[id].ts
export default defineEventHandler((event) => {
  const id = parseInt(event.context.params.id) as number

  if (!Number.isInteger(id)) {
    throw createError({
      statusCode: 400,
      statusMessage: 'ID 应该是一个整数',
    })
  }
  return '一切正常'
})

状态码

要返回其他状态码，请使用 setResponseStatus 工具。

例如，要返回 202 Accepted

server/api/validation/[id].ts
export default defineEventHandler((event) => {
  setResponseStatus(event, 202)
})

运行时配置

export default defineEventHandler(async (event) => {
  const config = useRuntimeConfig(event)

  const repo = await $fetch('https://api.github.com/repos/nuxt/nuxt', {
    headers: {
      Authorization: `token ${config.githubToken}`
    }
  })

  return repo
})
将 event 作为参数传递给 useRuntimeConfig 是可选的，但建议传递它，以便在运行时获取被 环境变量 重写的运行时配置，用于服务器路由。

请求 Cookies

server/api/cookies.ts
export default defineEventHandler((event) => {
  const cookies = parseCookies(event)

  return { cookies }
})

转发上下文和头信息

默认情况下，在服务器路由中进行 fetch 请求时，不会转发传入请求中的头信息和请求上下文。您可以使用 event.$fetch 在服务器路由中进行 fetch 请求时转发请求上下文和头信息。

server/api/forward.ts
export default defineEventHandler((event) => {
  return event.$fetch('/api/forwarded')
})
不应转发的头信息将不会包含在请求中。这些头信息包括，例如： transfer-encoding、connection、keep-alive、upgrade、expect、host、accept

等待响应后的承诺

在处理服务器请求时，您可能需要执行不应阻塞对客户端响应的异步任务（例如，缓存和记录）。您可以使用 event.waitUntil 在后台等待一个 Promise，而不延迟响应。

event.waitUntil 方法接受一个 Promise，该 Promise 将在处理程序终止之前被等待，以确保任务完成，即使服务器本来会在响应发送后立即终止处理程序。这与运行时提供程序集成，以利用它们的原生能力，在响应发送后处理异步操作。

server/api/background-task.ts
const timeConsumingBackgroundTask = async () => {
  await new Promise((resolve) => setTimeout(resolve, 1000))
};

export default eventHandler((event) => {
  // 在不阻塞响应的情况下安排一个后台任务
  event.waitUntil(timeConsumingBackgroundTask())

  // 立即将响应发送给客户端
  return '完成'
});

高级用法

Nitro 配置

您可以在 nuxt.config 中使用 nitro 键直接设置 Nitro 配置。

这是一个高级选项。自定义配置可能会影响生产部署，因为在 Nuxt 的次要版本中升级 Nitro 时，配置接口可能会发生变化。
nuxt.config.ts
export default defineNuxtConfig({
  // https://nitro.zhcndoc.com/config
  nitro: {}
})
Read more in Docs > Guide > Concepts > Server Engine.

嵌套路由

server/api/hello/[...slug].ts
import { createRouter, defineEventHandler, useBase } from 'h3'

const router = createRouter()

router.get('/test', defineEventHandler(() => 'Hello World'))

export default useBase('/api/hello', router.handler)

发送流

这是一个实验性功能，在所有环境中可用。
server/api/foo.get.ts
import fs from 'node:fs'
import { sendStream } from 'h3'

export default defineEventHandler((event) => {
  return sendStream(event, fs.createReadStream('/path/to/file'))
})

发送重定向

server/api/foo.get.ts
export default defineEventHandler(async (event) => {
  await sendRedirect(event, '/path/redirect/to', 302)
})

继承处理程序或中间件

server/api/legacy.ts
export default fromNodeMiddleware((req, res) => {
  res.end('遗留处理程序')
})
使用 unjs/h3 是可能的，但建议尽可能避免遗留处理程序。
server/middleware/legacy.ts
export default fromNodeMiddleware((req, res, next) => {
  console.log('遗留中间件')
  next()
})
切勿将 next() 回调与异步或返回 Promise 的遗留中间件结合使用。

服务器存储

Nitro 提供了一个跨平台的 存储层。为了配置其他存储挂载点，您可以使用 nitro.storage 或 服务器插件。

添加 Redis 存储的示例：

使用 nitro.storage：

nuxt.config.ts
export default defineNuxtConfig({
  nitro: {
    storage: {
      redis: {
        driver: 'redis',
        /* redis 连接选项 */
        port: 6379, // Redis 端口
        host: "127.0.0.1", // Redis 主机
        username: "", // 需要 Redis >= 6
        password: "",
        db: 0, // 默认为 0
        tls: {} // tls/ssl
      }
    }
  }
})

然后在您的 API 处理程序中：

server/api/storage/test.ts
export default defineEventHandler(async (event) => {
  // 列出所有关键字
  const keys = await useStorage('redis').getKeys()

  // 设置一个关键字
  await useStorage('redis').setItem('foo', 'bar')

  // 删除一个关键字
  await useStorage('redis').removeItem('foo')

  return {}
})
了解更多关于 Nitro 存储层的信息。

或者，您可以使用服务器插件和运行时配置创建一个存储挂载点：

import redisDriver from 'unstorage/drivers/redis'

export default defineNitroPlugin(() => {
  const storage = useStorage()

  // 动态传递来自运行时配置或其他来源的凭据
  const driver = redisDriver({
      base: 'redis',
      host: useRuntimeConfig().redis.host,
      port: useRuntimeConfig().redis.port,
      /* 其他 redis 连接选项 */
    })

  // 挂载驱动程序
  storage.mount('redis', driver)
})