Что использовали по Swagger?

Swagger — это набор инструментов для описания, документирования и тестирования REST API.

Что обычно используют по Swagger:

• OpenAPI Specification (ранее Swagger Specification) — стандарт описания API в формате YAML или JSON.
• Swagger Editor — веб-инструмент для написания и редактирования спецификаций OpenAPI.
• Swagger UI — автоматически генерируемая интерактивная документация API, позволяющая тестировать запросы прямо из браузера.
• Swagger Codegen — генерация клиентских SDK и серверных заглушек на основе спецификации.

Применение Swagger позволяет:

• Четко описать структуру API.
• Обеспечить единый источник правды для разработчиков.
• Упростить интеграцию и тестирование.

Пример простого описания GET-запроса в OpenAPI:

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