使用 Vue & UI Pro 的仪表板模板

server

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

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

目录结构
-| server/
---| api/
-----| hello.ts      # /api/hello
---| routes/
-----| bonjour.ts    # /bonjour
---| middleware/
-----| log.ts        # log all requests

每个文件都应该导出一个使用 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 可访问。

请注意,目前服务器路由不支持与 页面 相同的动态路由的全部功能。

服务器中间件

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 插件 中了解更多信息。

服务器实用程序

服务器路由由 unjs/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 {
      // do something before the route handler
      const response = await handler(event)
      // do something after the route handler
      return { response }
    } catch (err) {
      // Error handling
      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(() => '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) => {
  // handle GET requests for the `api/foo` endpoint
})

通配路由

通配路由有助于处理回退路由。

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

server/api/foo/[...].ts
export default defineEventHandler((event) => {
  // event.context.path to get the route path: '/api/foo/bar/baz'
  // event.context.params._ to get the route segment: 'bar/baz'
  return `Default foo handler`
})

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

server/api/foo/[...slug].ts
export default defineEventHandler((event) => {
  // event.context.params.slug to get the route segment: '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
<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 should be an integer',
    })
  }
  return 'All good'
})

状态码

要返回其他状态码,请使用 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 是可选的,但建议您传递它以获取在运行时被 环境变量 覆盖的运行时配置,适用于服务器路由。

请求 Cookie

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

  return { cookies }
})

高级用法

Nitro 配置

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

这是一个高级选项。自定义配置可能会影响生产部署,因为配置接口可能会随着时间的推移而改变,当 Nitro 在 Nuxt 的次要版本中升级时。
nuxt.config.ts
export default defineNuxtConfig({
  // https://nitro.unjs.io/config
  nitro: {}
})
文档 > 指南 > 概念 > 服务器引擎 中了解更多信息。

嵌套路由

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('Legacy handler')
})
可以使用 unjs/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 connector options */
        port: 6379, // Redis port
        host: "127.0.0.1", // Redis host
        username: "", // needs Redis >= 6
        password: "",
        db: 0, // Defaults to 0
        tls: {} // tls/ssl
      }
    }
  }
})

然后在您的 API 处理程序中

server/api/storage/test.ts
export default defineEventHandler(async (event) => {
  // List all keys with
  const keys = await useStorage('redis').getKeys()

  // Set a key with
  await useStorage('redis').setItem('foo', 'bar')

  // Remove a key with
  await useStorage('redis').removeItem('foo')

  return {}
})
阅读有关 Nitro 存储层的更多信息。

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

import redisDriver from 'unstorage/drivers/redis'

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

  // Dynamically pass in credentials from runtime configuration, or other sources
  const driver = redisDriver({
      base: 'redis',
      host: useRuntimeConfig().redis.host,
      port: useRuntimeConfig().redis.port,
      /* other redis connector options */
    })

  // Mount driver
  storage.mount('redis', driver)
})