Как организовать типизацию ответов REST API и работу с несколькими связанными эндпоинтами (например, список сущностей и получение сущности по ID)?

Основы типизации REST API

При работе с REST API важно заранее определить типы данных, которые возвращает сервер. В TypeScript для этого используются интерфейсы и типы. Например, для сущности пользователя можно создать интерфейс User, а для ответа — интерфейс ApiResponse, который содержит поле data.

interface User {
  id: number;
  name: string;
  email: string;
}

interface ApiResponse<T> {
  data: T;
  status: number;
}

Типизация связанных эндпоинтов

Когда есть несколько связанных эндпоинтов, например, список пользователей и получение пользователя по ID, удобно использовать обобщённые типы. Это позволяет переиспользовать общую структуру ответа и избегать дублирования кода.

interface ListResponse<T> {
  items: T[];
  total: number;
}

async function fetchUsers(): Promise<ListResponse<User>> {
  const res = await fetch('/api/users');
  return res.json();
}

async function fetchUser(id: number): Promise<ApiResponse<User>> {
  const res = await fetch(`/api/users/${id}`);
  return res.json();
}

Практическое применение

Такая типизация помогает на этапе разработки: IDE подсказывает поля, а компилятор ловит ошибки до выполнения. Это особенно полезно в больших проектах, где API меняется часто. Также можно использовать библиотеки, например, axios с дженериками, чтобы автоматически типизировать ответы.

Вывод

Типизация REST API через обобщённые интерфейсы делает код надёжнее и читабельнее. Применяйте её в любом проекте на TypeScript, где есть взаимодействие с сервером, чтобы снизить количество ошибок и ускорить разработку.