OpenAPI / Swagger

Что такое OpenAPI (ранее Swagger)?

OpenAPI — это спецификация, позволяющая описать структуру REST API в стандартизированном формате (обычно YAML или JSON). Ранее этот стандарт был известен как Swagger, но теперь Swagger — это инструмент, а спецификация называется OpenAPI.

Зачем нужен OpenAPI?

• Автогенерация документации API
• Генерация кода клиента и сервера
• Интерактивное тестирование через Swagger UI
• Единый формат для командной работы

Пример OpenAPI-документа (YAML)

openapi: 3.0.0
info:
  title: User API
  version: 1.0.0
paths:
  /users:
    get:
      summary: Get all users
      responses:
        '200':
          description: OK

Swagger UI

Swagger UI — это веб-интерфейс для визуализации OpenAPI-документации. Вы можете подключить YAML-файл и получить интерактивный интерфейс для тестирования API прямо в браузере.

Как создать OpenAPI-документ?

1. Описать API вручную в YAML/JSON
2. Сгенерировать автоматически (через Swagger, FastAPI, NestJS и др.)
3. Использовать Swagger Editor для визуального редактирования