快速开始

从一个全新的 Nitro 项目开始，或在现有的 Vite 项目中采用它。

#在线试用 Nitro

在我们的游乐场中通过浏览器体验 Nitro。

创建 Nitro 应用最快的方式是使用 create-nitro-app。

Note

请确保你已安装最新的 LTS 版本 Node.js、Bun 或 Deno。

npx create-nitro-app

预览

按照 CLI 指引操作，你就可以启动开发服务器了。

你可以将 Nitro 添加到任何现有的 Vite 项目中，以获得 API 路由、服务端渲染等功能。

npm i nitro vite

将 Nitro 插件添加到你的 vite.config.ts 中：

vite.config.ts

import { defineConfig } from "vite";
import { nitro } from "nitro/vite";

export default defineConfig({
  plugins: [
    nitro()
  ],
});

创建 nitro.config.ts 来配置服务器目录：

nitro.config.ts

import { defineConfig } from "nitro";

export default defineConfig({
  serverDir: "./server",
});

serverDir 选项告诉 Nitro 在哪里查找服务器路由。在此示例中，所有路由都将位于 server/ 目录中。默认情况下，serverDir 为 false，因此在设置它（或 scanDirs）之前不会扫描任何目录。

在 server/api/test.ts 创建你的第一个 API 路由：

server

api

test.ts

nitro.config.ts

vite.config.ts

import { defineHandler } from "nitro";

export default defineHandler(() => {
  return { message: "Hello Nitro!" };
});

文件路径会直接映射到路由 URL：server/api/test.ts 会变成 /api/test。处理器可以返回字符串、JSON 对象、Response 实例或可读流。

Tip

作为文件系统路由的替代方案，你可以使用 routes 配置选项以编程方式声明路由。查看程序化路由处理器了解更多详情。

npm run dev

你的 API 路由现在可以通过 http://localhost:3000/api/test 访问 :sparkles:

On this page