route.js

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

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

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

Справочник

HTTP-методы

Файл route позволяет создавать пользовательские обработчики запросов для указанного маршрута. Поддерживаются следующие 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) {}

// Если `OPTIONS` не определен, Next.js автоматически реализует `OPTIONS` и установит соответствующий заголовок `Allow` в Response в зависимости от других методов, определенных в обработчике маршрута.
export async function OPTIONS(request: Request) {}

export async function GET(request) {}

export async function HEAD(request) {}

export async function POST(request) {}

export async function PUT(request) {}

export async function DELETE(request) {}

export async function PATCH(request) {}

// Если `OPTIONS` не определен, Next.js автоматически реализует `OPTIONS` и установит соответствующий заголовок `Allow` в Response в зависимости от других методов, определенных в обработчике маршрута.
export async function OPTIONS(request) {}

Объект request является объектом NextRequest, который расширяет Web API Request. NextRequest предоставляет дополнительный контроль над входящим запросом, включая удобный доступ к cookies и расширенному, разобранному URL-объекту nextUrl.

import type { NextRequest } from 'next/server'

export async function GET(request: NextRequest) {
  const url = request.nextUrl
}

export async function GET(request) {
  const url = request.nextUrl
}

`context` (опционально)

params: промис, который разрешается в объект, содержащий динамические параметры маршрута для текущего маршрута.

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

export async function GET(request, { params }) {
  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'] }>`

Примеры

Работа с cookies

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

import { cookies } from 'next/headers'

export async function GET(request) {
  const cookieStore = await cookies()

  const a = cookieStore.get('a')
  const b = cookieStore.set('b', '1')
  const c = cookieStore.delete('c')
}

История версий

Версия	Изменения
`v15.0.0-RC`	`context.params` теперь является промисом. Доступен кодмод
`v15.0.0-RC`	Кеширование по умолчанию для обработчиков `GET` изменено со статического на динамическое
`v13.2.0`	Добавлены обработчики маршрутов (Route Handlers).

Справочник

HTTP-методы

Параметры

`request` (опционально)

`context` (опционально)

Примеры

Работа с cookies

История версий

On this page