Topvisor OpenAPI (Swagger)

OpenAPI — это спецификация (формат описания) для документирования и стандартизации REST API.

Основное

• Формально называется OpenAPI Specification (OAS).

• Раньше называлась Swagger Specification (до версии 3.0).

• Представляет собой JSON или YAML-файл, описывающий:

  • доступные эндпоинты (URL)

  • параметры

  • схемы данных (модели объектов)

  • форматы ответов

  • аутентификацию и авторизацию

Зачем нужен

• Унификация: API описывается в одном стандартизованном виде.

• Документация: из OpenAPI можно генерировать читаемую документацию (например, Swagger UI, Redoc).

• Генерация кода: по спецификации можно автоматически сгенерировать клиентские SDK и серверные заглушки.

• Валидация: проверка запросов и ответов на соответствие спецификации.

Подробную информацию смотрите в проекте на GitHub: https://github.com/topvisor/topvisor-openapi/.

Для работы в JS / TS / NodeJS используйте удобный API клиент: API клиент