nuxt logo

文档翻译(非官方)

modules

使用 modules/ 目录自动注册应用程序中的本地模块。

这是放置您在构建应用程序时开发的任何本地模块的好地方。

自动注册的文件模式为:

  • modules/*/index.ts
  • modules/*.ts

您不需要将这些本地模块单独添加到您的 nuxt.config.ts 中。

// `nuxt/kit` 是一个辅助子路径导入,您可以在定义本地模块时使用
// 这意味着您不需要将 `@nuxt/kit` 添加到项目的依赖项中
import { createResolver, defineNuxtModule, addServerHandler } from 'nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'hello'
  },
  setup () {
    const resolver = createResolver(import.meta.url)

    // 添加一个 API 路由
    addServerHandler({
      route: '/api/hello',
      handler: resolver.resolve('./runtime/api-route')
    })
  }
})

启动 Nuxt 时,hello 模块将被注册,并且 /api/hello 路由将可用。

模块按以下顺序执行:

  • 首先,加载在 nuxt.config.ts 中定义的模块。
  • 然后,执行在 modules/ 目录中找到的模块,并按字母顺序加载。

您可以通过在每个目录名称前添加一个数字来更改本地模块的顺序:

Directory structure
modules/
  1.first-module/
    index.ts
  2.second-module.ts
另请参阅 guide > going-further > modules

观看关于 Nuxt 私有模块的 Vue School 视频。