Какие типы контрактов применяются при создании REST API?

При создании REST API применяются следующие типы контрактов:

• OpenAPI (Swagger) — стандарт для описания REST API, который позволяет документировать и генерировать клиентский код.
• JSON Schema — определяет структуру JSON-объектов, используемых в запросах и ответах.
• gRPC (хотя это не REST, но иногда используется как контракт для API) — протокол с контрактом на основе protobuf.

В контексте REST API чаще всего используют OpenAPI, который описывает:

• Эндпоинты (пути и методы HTTP)
• Форматы запросов и ответов
• Параметры и заголовки
• Коды ответов

Пример простого OpenAPI фрагмента:

paths:
  /users:
    get:
      summary: Получить список пользователей
      responses:
        '200':
          description: Успешный ответ
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'