Была ли договоренность об описании модели и запросов к Backend в проекте

«Была ли договоренность об описании модели и запросов к Backend в проекте» — вопрос из категории Архитектура, который задают на 10% собеседований Frontend Разработчик. Ниже — развёрнутый ответ с разбором ключевых моментов.

Ответ

В современных проектах обычно есть соглашение между фронтом и беком по API. Чаще всего используется:

  1. Swagger/OpenAPI - стандартный способ документирования API с описанием моделей, эндпоинтов и примеров запросов/ответов
  2. GraphQL Schema - если проект использует GraphQL, схема типизирует все запросы и ответы
  3. Postman коллекции - иногда бекенд предоставляет готовые примеры запросов

Пример описания модели в Swagger:

User:
  type: object
  properties:
    id:
      type: integer
    name:
      type: string
    email:
      type: string

На практике фронтенд и бекенд команды согласовывают:

  • Формат данных (JSON/XML)
  • Статус коды ошибок
  • Пагинацию
  • Фильтрацию
  • Версионирование API

Без четкого соглашения велик риск несовместимости интерфейсов.