Проектирование REST API

Основа с Junior

Ресурсы, методы, коды ответа, пагинация, идемпотентность, версии и совместимость.

Что важно знать

Ресурсы — существительные (/orders/42), действия — методами.
Коды: 201 при создании, 204 без тела, 400/422 — ошибки данных, 401/403, 404, 409 — конфликт, 429 — лимит.
Идемпотентность: повтор PUT и DELETE безопасен, для POST — ключ идемпотентности.
Пагинация: курсор вместо offset на больших таблицах.
Ошибки в едином формате (RFC 9457 Problem Details).
Совместимость: добавлять поля можно, удалять и менять смысл — только с новой версией.
Контракт в OpenAPI — генерация клиентов и документации.

Критерии освоения

Junior ≈ 6 ч

Проектирует ресурсы и эндпоинты с правильными методами и кодами ответа
Описывает API в OpenAPI

Практика. Спроектировать и реализовать API заказов (создание, список, получение, отмена) с описанием в OpenAPI.

Middle ≈ 8 ч

Делает пагинацию курсором, фильтрацию и единый формат ошибок
Обеспечивает идемпотентность создания через ключ идемпотентности
Отличает совместимые изменения API от ломающих

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

Senior ≈ 4 ч

Выстраивает версионирование и политику изменений публичного API для внешних клиентов

Практика. Описать политику версионирования и депрекации API для партнёров и провести изменение без поломки клиентов.

Вопросы с собеседований

Добавь эндпоинт GET /users/{id}, возвращающий User по идентификатору. Junior
@RestController с @GetMapping("/users/{id}") и @PathVariable; сервис возвращает Optional → 200 с DTO или 404; наружу отдавать DTO, а не сущность JPA.
Как в Spring Boot 3 возвращать ошибки REST API в едином формате? Middle
@RestControllerAdvice с @ExceptionHandler централизует обработку, а ответ — ProblemDetail (стандарт RFC 9457, application/problem+json): type, title, status, detail, instance и…
Что означает код ответа 404? Junior
404 Not Found — ресурса по этому адресу нет. Это группа 4xx — ошибка на стороне клиента; 5xx — ошибка сервера.
Чем REST отличается от SOAP? Middle
REST — архитектурный стиль поверх HTTP: ресурсы, методы, обычно JSON, кэширование, простота. SOAP — протокол обмена XML-сообщениями со строгим контрактом WSDL, стандартами…
Что означает буква R в аббревиатуре REST применительно к проектированию API? Junior
REST — Representational State Transfer: ресурсы адресуются URL, действия выражаются методами HTTP, клиент работает с представлениями ресурсов.
Что произойдёт при создании ресурса через POST, если контроллер возвращает ResponseEntity со статусом 201? Middle
201 Created сопровождают заголовком Location с адресом созданного ресурса; тело — созданный ресурс или пусто. Spring сам Location не проставляет.

Разборы темы

REST API: статусы, согласование и семантика
Ресурсы и HTTP-глаголы, статус-коды как контракт, content negotiation и message converters, идемпотентность и версионирование.
Проектирование API: REST, gRPC и события
Выбор стиля взаимодействия, семантика и идемпотентность HTTP, формат ошибок, курсорная пагинация против offset, версионирование и обратная совместимость, контрактное тестирование.

← Вся карта «Backend-разработчик»

Закрытая бета

Знать тему — половина дела

На живом собеседовании sotto слышит вопрос интервьюера и показывает короткий ответ и план. Оставьте контакт — пришлём доступ и промокод.

Промокод на 2 часа — сверх пробных 30 минут
Программа для Windows — скачать сразу, войти — через Яндекс ID или VK ID
Первыми узнаете о версии для Mac — пока sotto только для Windows
Прямая связь с разработчиком: что улучшить — сделаем