Обработчики маршрутов (Route Handlers)

Обработчики маршрутов (Route Handlers) позволяют создавать пользовательские обработчики запросов для заданного маршрута, используя веб-API Request и Response.

Полезно знать: Обработчики маршрутов доступны только внутри директории app. Они являются эквивалентом API Routes в директории pages, что означает, что вам не нужно использовать API Routes и Route Handlers вместе.

Соглашение

Обработчики маршрутов определяются в файле route.js|ts внутри директории app:

export const dynamic = 'force-dynamic' // по умолчанию auto
export async function GET(request: Request) {}

export const dynamic = 'force-dynamic' // по умолчанию auto
export async function GET(request) {}

Обработчики маршрутов могут быть вложены в директорию app, аналогично page.js и layout.js. Однако нельзя иметь файл route.js на том же уровне сегмента маршрута, что и page.js.

Поддерживаемые HTTP-методы

Поддерживаются следующие HTTP-методы: GET, POST, PUT, PATCH, DELETE, HEAD и OPTIONS. Если вызывается неподдерживаемый метод, Next.js вернёт ответ 405 Method Not Allowed.

Расширенные API `NextRequest` и `NextResponse`

Помимо поддержки нативных Request и Response, Next.js расширяет их с помощью NextRequest и NextResponse для предоставления удобных вспомогательных функций для сложных случаев использования.

Поведение

Кэширование

Обработчики маршрутов кэшируются по умолчанию при использовании метода GET с объектом Response.

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

Предупреждение TypeScript: Response.json() доступен только начиная с TypeScript 5.2. Если вы используете более старую версию TypeScript, вы можете использовать NextResponse.json() для типизированных ответов.

Отказ от кэширования

Вы можете отказаться от кэширования с помощью:

Использования объекта Request с методом GET.
Использования любого другого HTTP-метода.
Использования динамических функций, таких как cookies и headers.
Ручного указания динамического режима через настройки сегмента.

Например:

export async function GET(request: Request) {
  const { searchParams } = new URL(request.url)
  const id = searchParams.get('id')
  const res = await fetch(`https://data.mongodb-api.com/product/${id}`, {
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY!,
    },
  })
  const product = await res.json()

  return Response.json({ product })
}

export async function GET(request) {
  const { searchParams } = new URL(request.url)
  const id = searchParams.get('id')
  const res = await fetch(`https://data.mongodb-api.com/product/${id}`, {
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY,
    },
  })
  const product = await res.json()

  return Response.json({ product })
}

Аналогично, метод POST приведёт к динамической обработке маршрута.

export async function POST() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY!,
    },
    body: JSON.stringify({ time: new Date().toISOString() }),
  })

  const data = await res.json()

  return Response.json(data)
}

export async function POST() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY,
    },
    body: JSON.stringify({ time: new Date().toISOString() }),
  })

  const data = await res.json()

  return Response.json(data)
}

Полезно знать: Как и API Routes, обработчики маршрутов могут использоваться для обработки отправки форм. Ведётся работа над новой абстракцией для обработки форм и мутаций, которая будет глубоко интегрирована с React.

Разрешение маршрутов

Вы можете рассматривать route как примитив самого низкого уровня для маршрутизации.

Они не участвуют в layouts или клиентской навигации, как page.
Не может быть файла route.js на том же маршруте, что и page.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-методы для этого маршрута.

app/page.js

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

// ❌ Конфликт
// `app/route.js`
export async function POST(request) {}

Примеры

Следующие примеры показывают, как комбинировать обработчики маршрутов с другими API и функциями Next.js.

Ревалидация кэшированных данных

Вы можете ревалидировать кэшированные данные с помощью опции next.revalidate:

export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    next: { revalidate: 60 }, // Ревалидация каждые 60 секунд
  })
  const data = await res.json()

  return Response.json(data)
}

export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    next: { revalidate: 60 }, // Ревалидация каждые 60 секунд
  })
  const data = await res.json()

  return Response.json(data)
}

Альтернативно, вы можете использовать опцию revalidate в настройках сегмента:

export const revalidate = 60

Динамические функции

Обработчики маршрутов могут использоваться с динамическими функциями из Next.js, такими как cookies и headers.

Куки (Cookies)

Вы можете читать или устанавливать куки с помощью cookies из next/headers. Эта серверная функция может быть вызвана напрямую в обработчике маршрута или вложена в другую функцию.

Альтернативно, вы можете вернуть новый Response с заголовком Set-Cookie.

import { cookies } from 'next/headers'

export async function GET(request: Request) {
  const cookieStore = 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 = cookies()
  const token = cookieStore.get('token')

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

Вы также можете использовать базовые веб-API для чтения куки из запроса (NextRequest):

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

Заголовки (Headers)

Вы можете читать заголовки с помощью headers из next/headers. Эта серверная функция может быть вызвана напрямую в обработчике маршрута или вложена в другую функцию.

Экземпляр headers доступен только для чтения. Чтобы установить заголовки, нужно вернуть новый Response с новыми headers.

import { headers } from 'next/headers'

export async function GET(request: Request) {
  const headersList = 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 = headers()
  const referer = headersList.get('referer')

  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { referer: referer },
  })
}

Вы также можете использовать базовые веб-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)
}

Перенаправления (Redirects)

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: { slug: string } }
) {
  const slug = params.slug // 'a', 'b' или 'c'
}

export async function GET(request, { params }) {
  const slug = params.slug // 'a', 'b' или 'c'
}

Маршрут	Пример URL	`params`
`app/items/[slug]/route.js`	`/items/a`	`{ slug: 'a' }`
`app/items/[slug]/route.js`	`/items/b`	`{ slug: 'b' }`
`app/items/[slug]/route.js`	`/items/c`	`{ 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 будет "hello" для /api/search?query=hello
}

export function GET(request) {
  const searchParams = request.nextUrl.searchParams
  const query = searchParams.get('query')
  // query будет "hello" для /api/search?query=hello
}

Потоковая передача (Streaming)

Потоковая передача часто используется в сочетании с большими языковыми моделями (LLM), такими как OpenAI, для генерации контента с помощью ИИ. Узнайте больше о AI SDK.

import OpenAI from 'openai'
import { OpenAIStream, StreamingTextResponse } from 'ai'

const openai = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
})

export const runtime = 'edge'

export async function POST(req: Request) {
  const { messages } = await req.json()
  const response = await openai.chat.completions.create({
    model: 'gpt-3.5-turbo',
    stream: true,
    messages,
  })

  const stream = OpenAIStream(response)

  return new StreamingTextResponse(stream)
}

import OpenAI from 'openai'
import { OpenAIStream, StreamingTextResponse } from 'ai'

const openai = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
})

export const runtime = 'edge'

export async function POST(req) {
  const { messages } = await req.json()
  const response = await openai.chat.completions.create({
    model: 'gpt-3.5-turbo',
    stream: true,
    messages,
  })

  const stream = OpenAIStream(response)

  return new StreamingTextResponse(stream)
}

Эти абстракции используют веб-API для создания потока. Вы также можете использовать базовые веб-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)
}

Тело запроса (Request Body)

Вы можете прочитать тело Request с помощью стандартных методов Web API:

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 Body FormData)

Вы можете прочитать FormData с помощью функции request.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

Вы можете настроить заголовки CORS для конкретного обработчика маршрута (Route Handler) с помощью стандартных методов Web API:

export const dynamic = 'force-dynamic' // по умолчанию 'auto'

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 const dynamic = 'force-dynamic' // по умолчанию 'auto'

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 к нескольким обработчикам маршрутов можно использовать Middleware или файл next.config.js.

Также можно ознакомиться с нашим примером CORS.

Вебхуки (Webhooks)

Вы можете использовать обработчик маршрута для получения вебхуков от сторонних сервисов:

export async function POST(request: Request) {
  try {
    const text = await request.text()
    // Обработка данных вебхука
  } catch (error) {
    return new Response(`Ошибка вебхука: ${error.message}`, {
      status: 400,
    })
  }

  return new Response('Успешно!', {
    status: 200,
  })
}

export async function POST(request) {
  try {
    const text = await request.text()
    // Обработка данных вебхука
  } catch (error) {
    return new Response(`Ошибка вебхука: ${error.message}`, {
      status: 400,
    })
  }

  return new Response('Успешно!', {
    status: 200,
  })
}

В отличие от API Routes в Pages Router, здесь не требуется использовать bodyParser или дополнительные настройки.

Среда выполнения Edge и Node.js (Edge and Node.js Runtimes)

Обработчики маршрутов используют изоморфный Web API для поддержки как Edge, так и Node.js сред выполнения, включая поддержку потоковой передачи. Поскольку обработчики маршрутов используют ту же конфигурацию сегментов маршрута, что и страницы с макетами, они поддерживают долгожданные функции, такие как статически регенерируемые обработчики маршрутов общего назначения.

Вы можете использовать опцию конфигурации сегмента runtime для указания среды выполнения:

export const runtime = 'edge' // по умолчанию 'nodejs'

Невизуальные ответы (Non-UI Responses)

Обработчики маршрутов можно использовать для возврата невизуального контента. Обратите внимание, что sitemap.xml, robots.txt, иконки приложения и изображения для Open Graph имеют встроенную поддержку.

export const dynamic = 'force-dynamic' // по умолчанию 'auto'

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 const dynamic = 'force-dynamic' // по умолчанию 'auto'

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)

Обработчики маршрутов используют ту же конфигурацию сегментов маршрута, что и страницы с макетами.

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

API-справочник для специального файла route.js.

Обработчики маршрутов (Route Handlers)

route.js

On this page