Переглядач OpenAPI / Swagger

Візуалізація та перегляд документації API у форматах OpenAPI 3.0 та Swagger v2.

Про Переглядач OpenAPI / Swagger — Докладний посібник

Категорія: DevOps та стандарти 100% локально у браузері

OpenAPI Viewer — це клієнтський засіб перегляду документації для аналізу контрактів RESTful API. Він візуалізує специфікації Swagger 2.0 та OpenAPI 3.0 / 3.1 у форматах JSON або YAML без необхідності встановлення локального Swagger UI чи використання хмарних залежностей.

Інструмент пропонує зручну згруповану бічну навігацію для всіх кінцевих точок, відображаючи шляхи, методи HTTP (GET, POST, PUT, DELETE), параметри заголовків, рядки запитів, структуровані тіла запитів, коди відповідей HTTP та схеми даних.

#openapi #swagger #api #docs #rest #yaml #json

Ключові функції та можливості

  • Підтримка специфікацій Swagger 2.0 та OpenAPI 3.0 / 3.1 у форматах JSON і YAML
  • Інтерактивна бічна панель зі списком категоризованих ендпоінтів, методів HTTP та кодів стану
  • Глибоке розв'язання схем `$ref` із відображенням вкладених моделей даних та обмежень властивостей
  • 100% клієнтський офлайн-парсинг, що гарантує безпеку корпоративних приватних контрактів API

Як використовувати

  1. 1

    Вставте текст `swagger.json` чи `openapi.yaml` або завантажте файл специфікації безпосередньо.

  2. 2

    Переглядайте структуровану документацію API, відображену в інтерактивному засобі перегляду.

  3. 3

    Розгорніть будь-який ендпоінт, щоб переглянути заголовки запиту, схеми корисного навантаження та зразки відповідей.

Типові сценарії використання

  • → Аудит визначень бекенд-API без розгортання виділеного сервера Swagger UI
  • → Експрес-перевірка написаних вручну специфікацій OpenAPI на наявність некоректних посилань `$ref`
  • → Надання фронтенд-розробникам точних довідників схем під час інтеграції з API

Схожі інструменти

Часті запитання та конфіденційність

Чи може цей інструмент зчитувати специфікації YAML напряму?

Так. Вбудований YAML-парсер обробляє специфікації контрактів OpenAPI у форматах `.yaml` та `.json` повністю у браузері.

Чи завантажується моя конфіденційна специфікація API на зовнішні сервери?

Ні. Увесь парсинг документа та візуалізація схем виконуються виключно в локальній пам'яті вашого браузера.