server

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

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

Directory structure

-| 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('New request: ' + 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 plugin', nitroApp)
})

另请参阅 Nitro 插件

服务器实用工具

服务器路由由 h3js/h3 提供支持，后者附带了一套方便的助手。

另请参阅可用的 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"
}

目前，这些值在类型检查时不会被尊重（nuxt typecheck），但您应该在 IDE 中获得更好的类型提示。

配方

路由参数

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

server/api/hello/[name\

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(() => 'Test get handler')

server/api/test.post.ts

export default defineEventHandler(() => 'Test post handler')

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

GET 方法：返回 Test get handler
POST 方法：返回 Test post handler
任何其他方法：返回 405 错误

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

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

捕获所有路由

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

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

server/api/foo/[...\

export default defineEventHandler((event) => {
  // event.context.path 获取路由路径：'/api/foo/bar/baz'
  // event.context.params._ 获取路由段：'bar/baz'
  return `Default foo handler`
})

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

server/api/foo/[...slug\

export default defineEventHandler((event) => {
  // event.context.params.slug 获取路由段：'bar/baz'
  return `Default foo handler`
})

请求体处理

server/api/submit.post.ts

export default defineEventHandler(async (event) => {
  const body = await readBody(event)
  return { body }
})

或者，使用 readValidatedBody 和 Zod 等模式验证器以实现运行时和类型安全。

您现在可以使用以下方式通用地调用此 API：

app.vue

async function submit() {
  const { body } = await $fetch('/api/submit', {
    method: 'post',
    body: { test: 123 }
  })
}

我们在文件名中使用 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\

export default defineEventHandler((event) => {
  const id = parseInt(event.context.params.id) as number

  if (!Number.isInteger(id)) {
    throw createError({
      statusCode: 400,
      statusMessage: 'ID 应为整数',
    })
  }
  return 'All good'
})

状态码

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

例如，要返回 202 Accepted

server/api/validation/[id\

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

响应后等待 Promise

在处理服务器请求时，您可能需要执行不应阻塞对客户端响应的异步任务（例如，缓存和日志记录）。您可以使用 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 'done'
});

高级用法

Nitro 配置

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

这是一个高级选项。自定义配置可能会影响生产部署，因为当 Nitro 在 Nuxt 的 semver-minor 版本中升级时，配置接口可能会更改。

nuxt.config.ts

export default defineNuxtConfig({
  // https://nitro.build/config
  nitro: {}
})

另请参阅 guide > concepts > server-engine

嵌套路由

server/api/hello/[...slug\

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('Legacy handler')
})

使用 h3js/h3 可以实现旧支持，但建议尽可能避免使用旧处理程序。

server/middleware/legacy.ts

export default fromNodeMiddleware((req, res, next) => {
  console.log('Legacy middleware')
  next()
})

永远不要将 next() 回调与 async 或返回 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.build > guide > storage

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

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)
})

※此页面是 Nuxt.js 官方文档的非官方翻译页面。

官方文档中的相应页面在此处：
https://nuxt.com/docs/3.x/guide/directory-structure/server