route.js

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

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

Важно знать: Обработчики маршрутов доступны только внутри каталога app. Вам не нужно использовать API-маршруты (pages) и обработчики маршрутов (app) вместе, так как обработчики маршрутов должны быть способны обрабатывать все случаи использования.

Параметры

request (необязательно)

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

context (необязательно)

type Params = {
  team: string
}
 
export async function GET(request: Request, context: { params: Params }) {
  const team = context.params.team // '1'
}
 
// Define params type according to your route parameters (see table below)

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

NextResponse

Обработчики маршрутов могут расширить API Web Response, возвращая объект NextResponse. Это позволяет легко устанавливать куки, заголовки, перенаправлять и переписывать. См. ссылку на API.

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