API 路由

Open in Playground Source

基于文件的 API 路由，支持 HTTP 方法和动态参数。

api

hello

hello.ts

test.get.ts

test.post.ts

index.html

nitro.config.ts

package.json

tsconfig.json

vite.config.ts

import { defineHandler } from "nitro";

export default defineHandler(() => "Nitro is amazing!");

Nitro 支持在 api/ 或 routes/ 目录中进行基于文件的路由。每个文件都会根据其路径成为一个 API 端点。

#基本路由

在 api/ 目录中创建一个文件来定义路由。文件路径会成为 URL 路径：

api/hello.ts

import { defineHandler } from "nitro";

export default defineHandler(() => "Nitro is amazing!");

这会创建一个 GET /api/hello 端点。

#动态路由

使用方括号 [param] 表示动态 URL 段。通过 event.context.params 访问参数：

api/hello/[name

import { defineHandler } from "nitro";

export default defineHandler((event) => `Hello (param: ${event.context.params!.name})!`);

这会创建一个 GET /api/hello/:name 端点（例如，/api/hello/world）。

#HTTP 方法

在文件名后添加 HTTP 方法（.get.ts、.post.ts、.put.ts、.delete.ts 等）：

#GET 处理程序

api/test.get.ts

import { defineHandler } from "nitro";

export default defineHandler(() => "Test get handler");

#POST 处理程序

api/test.post.ts

import { defineHandler } from "nitro";

export default defineHandler(async (event) => {
  const body = await event.req.json();
  return {
    message: "Test post handler",
    body,
  };
});

#了解更多

路由

Edit this page

Previous 示例 Next 缓存处理器

On this page