路由處理器 (Route Handlers)

路由處理器 (Route Handlers) 允許您使用 Web Request 和 Response API 為指定路由建立自訂請求處理器。

須知事項：路由處理器僅在 app 目錄內可用。它們等同於 pages 目錄中的 API 路由，這表示您不需要同時使用 API 路由和路由處理器。

慣例

路由處理器定義在 app 目錄中的 route.js|ts 檔案：

export async function GET(request: Request) {}

export async function GET(request) {}

路由處理器可以像 page.js 和 layout.js 一樣嵌套在 app 目錄的任何位置。但在與 page.js 相同路由層級的位置不能存在 route.js 檔案。

支援的 HTTP 方法

支援以下 HTTP 方法：GET、POST、PUT、PATCH、DELETE、HEAD 和 OPTIONS。如果呼叫了不支援的方法，Next.js 會回傳 405 Method Not Allowed 回應。

擴展的 `NextRequest` 和 `NextResponse` API

除了支援原生的 Request 和 Response API 外，Next.js 還透過 NextRequest 和 NextResponse 進行擴展，為進階使用案例提供便利的輔助工具。

行為

快取

路由處理器預設不會被快取。不過，您可以選擇為 GET 方法啟用快取。其他支援的 HTTP 方法不會被快取。要快取 GET 方法，請在路由處理器檔案中使用路由配置選項，例如 export const dynamic = 'force-static'。

export const dynamic = 'force-static'

export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY,
    },
  })
  const data = await res.json()

  return Response.json({ data })
}

export const dynamic = 'force-static'

export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY,
    },
  })
  const data = await res.json()

  return Response.json({ data })
}

須知事項：其他支援的 HTTP 方法不會被快取，即使它們與已快取的 GET 方法位於同一個檔案中。

特殊路由處理器

特殊路由處理器如 sitemap.ts、opengraph-image.tsx 和 icon.tsx，以及其他元數據檔案預設保持靜態，除非它們使用動態 API 或動態配置選項。

路由解析

您可以將 route 視為最低層級的路由原語。

它們不會參與像 page 一樣的佈局或客戶端導航。
在與 page.js 相同的路由位置不能存在 route.js 檔案。

頁面	路由	結果
`app/page.js`	`app/route.js`	衝突
`app/page.js`	`app/api/route.js`	有效
`app/[user]/page.js`	`app/api/route.js`	有效

每個 route.js 或 page.js 檔案會接管該路由的所有 HTTP 動詞。

export default function Page() {
  return <h1>Hello, Next.js!</h1>
}

// ❌ 衝突
// `app/route.ts`
export async function POST(request: Request) {}

export default function Page() {
  return <h1>Hello, Next.js!</h1>
}

// ❌ 衝突
// `app/route.js`
export async function POST(request) {}

範例

以下範例展示如何將路由處理器與其他 Next.js API 和功能結合使用。

重新驗證快取數據

您可以使用增量靜態再生 (ISR) 重新驗證快取數據：

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)
}

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)
}

Cookies

您可以使用 next/headers 中的 cookies 讀取或設定 cookies。這個伺服器函數可以直接在路由處理器中呼叫，或嵌套在其他函數中。

或者，您可以使用 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}` },
  })
}

import { cookies } from 'next/headers'

export async function GET(request) {
  const cookieStore = await cookies()
  const token = cookieStore.get('token')

  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { 'Set-Cookie': `token=${token}` },
  })
}

您也可以使用底層 Web API 從請求 (NextRequest) 中讀取 cookies：

import { type NextRequest } from 'next/server'

export async function GET(request: NextRequest) {
  const token = request.cookies.get('token')
}

export async function GET(request) {
  const token = request.cookies.get('token')
}

標頭

您可以使用 next/headers 中的 headers 讀取標頭。這個伺服器函數可以直接在路由處理器中呼叫，或嵌套在其他函數中。

這個 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 },
  })
}

import { headers } from 'next/headers'

export async function GET(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)
}

export async function GET(request) {
  const requestHeaders = new Headers(request.headers)
}

重新導向

import { redirect } from 'next/navigation'

export async function GET(request: Request) {
  redirect('https://nextjs.org/')
}

import { redirect } from 'next/navigation'

export async function GET(request) {
  redirect('https://nextjs.org/')
}

動態路由區段

路由處理器可以使用動態區段從動態數據建立請求處理器。

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

export async function GET(request, { params }) {
  const { slug } = await params // 'a'、'b' 或 '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')
  // 對於 /api/search?query=hello，query 是 "hello"
}

export function GET(request) {
  const searchParams = request.nextUrl.searchParams
  const query = searchParams.get('query')
  // 對於 /api/search?query=hello，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())
}

import { openai } from '@ai-sdk/openai'
import { StreamingTextResponse, streamText } from 'ai'

export async function POST(req) {
  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://developer.mozilla.org/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)
}

// https://developer.mozilla.org/docs/Web/API/ReadableStream#convert_async_iterator_to_stream
function iteratorToStream(iterator) {
  return new ReadableStream({
    async pull(controller) {
      const { value, done } = await iterator.next()

      if (done) {
        controller.close()
      } else {
        controller.enqueue(value)
      }
    },
  })
}

function sleep(time) {
  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 })
}

export async function POST(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 })
}

export async function POST(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',
    },
  })
}

export async function GET(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 檔案。

或者，參閱我們的 CORS 範例套件。

Webhooks (網路鉤子)

你可以使用路由處理器 (Route Handler) 來接收來自第三方服務的 webhook (網路鉤子)：

export async function POST(request: Request) {
  try {
    const text = await request.text()
    // 處理 webhook 的有效負載
  } catch (error) {
    return new Response(`Webhook 錯誤: ${error.message}`, {
      status: 400,
    })
  }

  return new Response('成功!', {
    status: 200,
  })
}

export async function POST(request) {
  try {
    const text = await request.text()
    // 處理 webhook 的有效負載
  } catch (error) {
    return new Response(`Webhook 錯誤: ${error.message}`, {
      status: 400,
    })
  }

  return new Response('成功!', {
    status: 200,
  })
}

值得注意的是，與使用 Pages Router 的 API 路由不同，你不需要使用 bodyParser 或任何額外配置。

非 UI 回應

你可以使用路由處理器 (Route Handler) 來返回非 UI 內容。請注意 sitemap.xml、robots.txt、app icons 和 open graph images (開放圖譜圖片) 都內建支援。

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.org/docs</link>
  <description>The React Framework for the Web</description>
</channel>

</rss>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

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.org/docs</link>
  <description>The React Framework for the Web</description>
</channel>

</rss>`)
}

路由區段配置選項 (Segment Config Options)

路由處理器 (Route Handler) 使用與頁面和佈局相同的路由區段配置 (route segment configuration)。

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

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 參考文件。

route.js

關於 route.js 特殊檔案的 API 參考文件。

route.js

On this page