NESTJS - Использование типа HTTP-запроса HEAD и GET для одного и того же маршрута

Содержание

Вопрос или проблема
Ответ или решение
Проблема
Решение
Пример кода
Объяснение
Заключение

Вопрос или проблема

По умолчанию в наших RESTful API мы используем HEAD для проверки существования сущности. Недавно я столкнулся с проблемой использования NestJS и типов HTTP-запросов HEAD и GET с одним и тем же маршрутом. По некоторым причинам, когда клиент делает HTTP-запрос HEAD к API, например, HEAD – /api/test, запрос направляется к контроллеру части GET кода. После некоторой отладки, похоже, что это связано с порядком методов в контроллере. Если вы разместите код для HEAD после GET, запрос будет перехвачен запросом GET. Если вы разместите его до этого, всё будет работать, как ожидается. Не знаю, почему это так, но хорошо знать.

Фрагмент кода:

// HEAD должен быть перед GET для контроллера NestJS с тем же маршрутом
@Head(':id')  // проверка существования сущности
  async hasOne(@Res() response, @Param('id') id): Promise<any> {

   // сделать что-то
  }

  @Get(':id') // Получить одну сущность
  getOne(@Param('id') id): Promise<any> {

   // сделать что-то
  }

Мы используем NestJS 10.4.4

Ответ заключается в вопросе, и это полезно знать, если вы реализуете HEAD, используя NestJS 10.4.4.

Ответ или решение

Вопрос, связанный с использованием методов HTTP HEAD и GET для одного и того же маршрута в NestJS, поднимает важные аспекты проектирования RESTful API и обработки запросов. Данная ситуация, с которой вы столкнулись, действительно имеет большое значение, особенно когда речь идет о корректной реализации API.

Проблема

При реализации API с использованием NestJS версии 10.4.4 возникает проблема, когда HTTP запрос типа HEAD на маршрут, обслуживаемый контроллером, маршрутизируется к методу GET. Это наблюдается из-за порядка определения методов в контроллере: если метод HEAD расположен после метода GET, возникнет конфликт, и запрос HEAD будет обработан как GET. Это может привести к неправильному поведению API, поскольку метод HEAD по своей природе должен возвращать заголовки ответа без тела.

Решение

Чтобы избежать такой ситуации, необходимо размещать метод HEAD перед методом GET в контроллере. Если вы правильно расставите методы, запросы HEAD будут корректно обрабатываться, а GET будет оставаться доступным для получения деталей сущности.

Пример кода

Вот пример того, как это должно выглядеть в вашем контроллере:

import { Controller, Get, Head, Param, Res } from '@nestjs/common';
import { Response } from 'express';

@Controller('api/test')
export class TestController {
  @Head(':id')  // Проверка существования сущности
  async hasOne(@Res() response: Response, @Param('id') id: string): Promise<any> {
    // Логика проверки существования сущности
    const exists = await this.someService.exists(id);

    if (exists) {
      response.status(204).send();  // 204 No Content если существует
    } else {
      response.status(404).send();  // 404 Not Found если не существует
    }
  }

  @Get(':id') // Получение одной сущности
  async getOne(@Param('id') id: string): Promise<any> {
    return await this.someService.findOneById(id);  // Логика получения сущности
  }
}

Объяснение

Расстановка методов: Важно, чтобы метод HEAD был определен первым для избежания конфликта. При таком подходе, если клиент отправит запрос типа HEAD, NestJS корректно направит его в метод hasOne. Если же вы разместите метод HEAD после GET, NestJS обработает его как GET, что приведет к неправильному поведению и потенциальным ошибкам.
Стандарты REST: Использование метода HEAD позволяет клиентам проверять существование ресурса, не загружая его полное представление. Это улучшает производительность и позволяет экономить пропускную способность, что особенно важно для API с высокой нагрузкой.
Возврат статусов: Метод HEAD может использовать разные коды состояния HTTP для обозначения состояния запрашиваемого ресурса, такие как 204 (Нет содержимого) для существующих сущностей и 404 (Не найдено) для отсутствующих.

Заключение

Соблюдение правильного порядка методов в контроллерах NestJS критично для успешной реализации RESTful API. Всегда помните о том, что порядок имеет значение — это не только касается маршрутов, но и всех аспектов разработки. Правильное проектирование API обеспечит его надежность и удобство использования, что, в свою очередь, повысит удовлетворенность ваших клиентов.

NESTJS – Использование типа HTTP-запроса HEAD и GET для одного и того же маршрута