入门指南

创建具有所有必要功能的网络服务器,并将其部署到您喜欢的地方。

您当前正在阅读的是 Nitro v3 beta 文档。 查看 迁移指南 以了解从 Nitro v2 迁移的相关信息。

介绍

Nitro 是一个开源框架,用于使用 unjs/h3 构建网络服务器,并提供大量内置功能。 Nitro 自动使您的代码与任何 部署 提供者和运行时兼容!

Nitro 可以单独使用,也可以作为全栈框架的服务器引擎,例如 Nuxt

快速开始

您可以使用 在线 playground 而不是设置本地开发环境。
确保您已安装推荐的环境:

使用启动模板创建新项目:

npx giget@latest nitro nitro-app --install
cd nitro-app

启动开发服务器:

npm run dev

Nitro 在 http://localhost:3000/ 运行就绪!

如果您想了解发生了什么,请检查 .nitro/dev/index.mjs

构建可用于生产的服务器:

npm run build

输出位于 .output 目录,并已准备好在几乎任何提供者上部署,无需依赖项。

您可以通过以下方式在本地进行尝试:

npm run preview
您可以在 Nitro 仓库中找到更多示例:nitrojs/nitro/examples

目录结构

启动模板包含一些重要文件,以便您快速入门。

server/routes/

server/routes/ 目录包含您的应用程序处理程序。您可以在 server/routes/ 目录中创建子目录,以创建嵌套处理程序。文件名即为路由路径。

Read more in Guide > Routing.

server/api/

server/api/ 目录与 server/routes/ 类似,唯一不同之处在于其中的路由将以 /api/ 为前缀以方便访问。

Read more in Guide > Routing.

server/utils/

此目录包含您的应用程序工具,并支持自动导入。

Read more in Guide > Utils.

server/plugins/

此目录包含您的自定义 Nitro 插件。

Read more in Guide > Plugins.

nitro.config.ts

nitro.config.ts 文件包含 Nitro 的配置。

Read more in Guide > Configuration.

tsconfig.json

tsconfig.json 文件包含您的项目的 TypeScript 配置。

Read more in Guide > Typescript.

package.json

package.json 文件包含您项目的所有依赖项和脚本。