Guide

配置

自定义和扩展 Nitro 默认设置。

有关可用选项,请参见 配置参考

您可以通过配置文件自定义 Nitro 构建器。

export default defineNitroConfig({
  // Nitro 选项
})
如果您使用 Nuxt,请在 Nuxt 配置中使用 nitro 选项。
Nitro 使用 unjs/c12 加载配置,使您可以在当前工作目录或用户主目录中使用 .nitrorc 文件,提供了更多可能性。

运行时配置

Nitro 提供了一个运行时配置 API,以在您的应用程序中暴露配置,并通过设置环境变量在运行时更新它。这在您需要为不同环境(例如开发、预发布、生产)暴露不同配置值时非常有用。例如,您可以使用此功能为不同环境暴露不同的 API 端点或不同的特性标志。

首先,您需要在配置文件中定义运行时配置。

export default defineNitroConfig({
  runtimeConfig: {
    apiToken: "dev_token", // `dev_token` 是默认值
  }
})

现在您可以使用 useRuntimeConfig(event) 访问运行时配置。在事件处理程序和实用程序中使用 useRuntimeConfig(event),并避免在环境全局上下文中调用它。这可能导致意想不到的行为,例如在不同请求之间共享相同的运行时配置。

export default defineEventHandler((event) => {
  return useRuntimeConfig(event).apiToken // 返回 `dev_token`
});

本地开发

最后,您可以使用环境变量更新运行时配置。您可以在开发中使用 .env 文件,在生产中使用平台变量(见下文)。

在项目根目录中创建一个 .env 文件:

.env
NITRO_API_TOKEN="123"

重新启动开发服务器,获取 /api/example 端点,您应该看到 123 作为响应,而不是 dev_token

不要忘记,您仍然可以使用 import.meta.envprocess.env 全局访问环境变量,但请避免在环境全局上下文中使用它们,以防止意外行为。

生产

您可以在生产环境中定义变量以更新运行时配置。所有变量必须以 NITRO_ 为前缀才能应用于运行时配置。这些变量将覆盖您在 nitro.config.ts 文件中定义的运行时配置变量。

NITRO_API_TOKEN="123"

在运行时配置中,使用 camelCase 定义键。在环境变量中,使用 snake_case 和大写字母定义键。

{
  helloWorld: "foo"
}
NITRO_HELLO_WORLD="foo"