route.js

路由處理器允許您使用 Web 請求和響應 API 為給定路由建立自定義請求處理器。

export async function GET() {
  return Response.json({ message: 'Hello World' })
}

參考

HTTP 方法

路由檔案允許您為給定路由建立自定義請求處理器。支援以下 HTTP 方法：GET、POST、PUT、PATCH、DELETE、HEAD 和 OPTIONS。

export async function GET(request: Request) {}
 
export async function HEAD(request: Request) {}
 
export async function POST(request: Request) {}
 
export async function PUT(request: Request) {}
 
export async function DELETE(request: Request) {}
 
export async function PATCH(request: Request) {}
 
// If `OPTIONS` is not defined, Next.js will automatically implement `OPTIONS` and set the appropriate Response `Allow` header depending on the other methods defined in the Route Handler.
export async function OPTIONS(request: Request) {}

引數

`request` (可選)

request 物件是一個 NextRequest 物件，它是 Web Request API 的擴充套件。NextRequest 為傳入的請求提供了進一步的控制，包括輕鬆訪問 cookies 和一個擴充套件的、解析後的 URL 物件 nextUrl。

import type { NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const url = request.nextUrl
}

`context` (可選)

params：一個 Promise，解析為包含當前路由的動態路由引數的物件。

export async function GET(
  request: Request,
  { params }: { params: Promise<{ team: string }> }
) {
  const { team } = await params
}

示例	URL	`params`
`app/dashboard/[team]/route.js`	`/dashboard/1`	`Promise<{ team: '1' }>`
`app/shop/[tag]/[item]/route.js`	`/shop/1/2`	`Promise<{ tag: '1', item: '2' }>`
`app/blog/[...slug]/route.js`	`/blog/1/2`	`Promise<{ slug: ['1', '2'] }>`

路由上下文助手

您可以使用 RouteContext 對路由處理器上下文進行型別標註，以從路由字面量獲取強型別的 params。RouteContext 是一個全域性可用的助手。

import type { NextRequest } from 'next/server'
 
export async function GET(_req: NextRequest, ctx: RouteContext<'/users/[id]'>) {
  const { id } = await ctx.params
  return Response.json({ id })
}

須知

型別在 next dev、next build 或 next typegen 期間生成。

在型別生成之後，RouteContext 助手全域性可用。無需匯入。

示例

Cookies

您可以使用 next/headers 中的 cookies 讀取或設定 cookie。

import { cookies } from 'next/headers'
 
export async function GET(request: NextRequest) {
  const cookieStore = await cookies()
 
  const a = cookieStore.get('a')
  const b = cookieStore.set('b', '1')
  const c = cookieStore.delete('c')
}

或者，您可以使用 Set-Cookie 標頭返回新的 Response。

import { cookies } from 'next/headers'
 
export async function GET(request: Request) {
  const cookieStore = await cookies()
  const token = cookieStore.get('token')
 
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { 'Set-Cookie': `token=${token.value}` },
  })
}

您還可以使用底層 Web API 從請求（NextRequest）中讀取 cookie。

import { type NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const token = request.cookies.get('token')
}

標頭

您可以使用 next/headers 中的 headers 讀取標頭。

import { headers } from 'next/headers'
import type { NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const headersList = await headers()
  const referer = headersList.get('referer')
}

此 headers 例項是隻讀的。要設定標頭，您需要返回一個帶有新 headers 的新 Response。

import { headers } from 'next/headers'
 
export async function GET(request: Request) {
  const headersList = await headers()
  const referer = headersList.get('referer')
 
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { referer: referer },
  })
}

您還可以使用底層 Web API 從請求（NextRequest）中讀取標頭。

import { type NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const requestHeaders = new Headers(request.headers)
}

重新驗證快取資料

您可以使用 revalidate 路由段配置選項重新驗證快取資料。

export const revalidate = 60
 
export async function GET() {
  const data = await fetch('https://api.vercel.app/blog')
  const posts = await data.json()
 
  return Response.json(posts)
}

重定向

import { redirect } from 'next/navigation'
 
export async function GET(request: Request) {
  redirect('https://nextjs.react.com.tw/')
}

動態路由段

路由處理器可以使用動態段從動態資料建立請求處理器。

export async function GET(
  request: Request,
  { params }: { params: Promise<{ slug: string }> }
) {
  const { slug } = await params // 'a', 'b', or 'c'
}

路由	示例 URL	`params`
`app/items/[slug]/route.js`	`/items/a`	`Promise<{ slug: 'a' }>`
`app/items/[slug]/route.js`	`/items/b`	`Promise<{ slug: 'b' }>`
`app/items/[slug]/route.js`	`/items/c`	`Promise<{ slug: 'c' }>`

URL 查詢引數

傳遞給路由處理器的請求物件是一個 NextRequest 例項，其中包含一些額外的便捷方法，例如用於更輕鬆地處理查詢引數的方法。

import { type NextRequest } from 'next/server'
 
export function GET(request: NextRequest) {
  const searchParams = request.nextUrl.searchParams
  const query = searchParams.get('query')
  // query is "hello" for /api/search?query=hello
}

流式傳輸

流式傳輸通常與大型語言模型 (LLM)（如 OpenAI）結合使用，用於生成 AI 內容。瞭解有關 AI SDK 的更多資訊。

import { openai } from '@ai-sdk/openai'
import { StreamingTextResponse, streamText } from 'ai'
 
export async function POST(req: Request) {
  const { messages } = await req.json()
  const result = await streamText({
    model: openai('gpt-4-turbo'),
    messages,
  })
 
  return new StreamingTextResponse(result.toAIStream())
}

這些抽象使用 Web API 來建立流。您也可以直接使用底層 Web API。

// https://mdn.club.tw/docs/Web/API/ReadableStream#convert_async_iterator_to_stream
function iteratorToStream(iterator: any) {
  return new ReadableStream({
    async pull(controller) {
      const { value, done } = await iterator.next()
 
      if (done) {
        controller.close()
      } else {
        controller.enqueue(value)
      }
    },
  })
}
 
function sleep(time: number) {
  return new Promise((resolve) => {
    setTimeout(resolve, time)
  })
}
 
const encoder = new TextEncoder()
 
async function* makeIterator() {
  yield encoder.encode('<p>One</p>')
  await sleep(200)
  yield encoder.encode('<p>Two</p>')
  await sleep(200)
  yield encoder.encode('<p>Three</p>')
}
 
export async function GET() {
  const iterator = makeIterator()
  const stream = iteratorToStream(iterator)
 
  return new Response(stream)
}

請求正文

您可以使用標準 Web API 方法讀取 Request 正文

export async function POST(request: Request) {
  const res = await request.json()
  return Response.json({ res })
}

請求正文 FormData

您可以使用 request.formData() 函式讀取 FormData

export async function POST(request: Request) {
  const formData = await request.formData()
  const name = formData.get('name')
  const email = formData.get('email')
  return Response.json({ name, email })
}

由於 formData 資料都是字串，您可能需要使用 zod-form-data 來驗證請求並以您喜歡的格式（例如 number）檢索資料。

CORS

您可以使用標準 Web API 方法為特定的路由處理器設定 CORS 標頭

export async function GET(request: Request) {
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: {
      'Access-Control-Allow-Origin': '*',
      'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
      'Access-Control-Allow-Headers': 'Content-Type, Authorization',
    },
  })
}

須知:

要為多個路由處理器新增 CORS 標頭，您可以使用代理或 next.config.js 檔案。

Webhooks

您可以使用路由處理器接收來自第三方服務的 Webhooks

export async function POST(request: Request) {
  try {
    const text = await request.text()
    // Process the webhook payload
  } catch (error) {
    return new Response(`Webhook error: ${error.message}`, {
      status: 400,
    })
  }
 
  return new Response('Success!', {
    status: 200,
  })
}

值得注意的是，與 Pages Router 中的 API 路由不同，您無需使用 bodyParser 進行任何額外的配置。

非 UI 響應

您可以使用路由處理器返回非 UI 內容。請注意，sitemap.xml、robots.txt、app icons 和開放圖譜影像都內建支援。

export async function GET() {
  return new Response(
    `<?xml version="1.0" encoding="UTF-8" ?>
<rss version="2.0">
 
<channel>
  <title>Next.js Documentation</title>
  <link>https://nextjs.react.com.tw/docs</link>
  <description>The React Framework for the Web</description>
</channel>
 
</rss>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

段配置選項

路由處理器使用與頁面和佈局相同的路由段配置。

export const dynamic = 'auto'
export const dynamicParams = true
export const revalidate = false
export const fetchCache = 'auto'
export const runtime = 'nodejs'
export const preferredRegion = 'auto'

更多詳細資訊請參見 API 參考。

版本歷史

版本	更改
`v15.0.0-RC`	`context.params` 現在是一個 Promise。提供了 codemod
`v15.0.0-RC`	`GET` 處理器的預設快取從靜態更改為動態。
`v13.2.0`	引入路由處理器。