Визуализатор спецификаций OpenAPI
Визуализатор спецификаций OpenAPI помогает быстро разобраться в незнакомом API; линтер в CI — то, что не даёт спецификации отойти от кода.
🔒 Этот инструмент работает полностью в вашем браузере. Ваши файлы никогда не загружаются на сервер.
Разработчик
Визуализатор спецификаций OpenAPI
Предпросмотр интерфейса — без загрузки и внешних сервисов.
Карта эндпоинтов
Спецификация из 2400 строк отображена как 8 групп по тегам, охватывающих 47 эндпоинтов, с 3 путями, отмеченными как не имеющие summary, и 2 схемами, определёнными, но никогда не используемыми.
Как работает визуализатор спецификаций OpenAPI
- Вставьте документ OpenAPI или Swagger в формате JSON или YAML.
- Группируйте по тегу, чтобы увидеть API так, как его организовали авторы, или по префиксу пути, чтобы увидеть структуру ресурсов.
- Ищите эндпоинты без описания и схемы, на которые никто не ссылается — оба признака того, что спецификация отошла от реализации.
FAQ
Какие версии OpenAPI поддерживаются?
Разбираются как OpenAPI 3.x, так и Swagger 2.0. Они различаются тем, как объявляются тела запросов и безопасность, что полезно знать, читая старую спецификацию рядом с новой.
Валидирует ли это спецификацию?
Он сообщает об очевидных структурных проблемах, таких как неиспользуемые схемы и отсутствующие summary. Полная проверка на соответствие спецификации требует специализированного линтера вроде Spectral, который также применяет собственные стилевые правила.
Загружается ли моя спецификация?
Нет. Разбор происходит в браузере, что важно, когда спецификация описывает внутренний API и перечисляет каждый его эндпоинт и поле.
Сравнение
| Функция | Online Tool Store | CLI-скрипт | Плагин для IDE |
|---|---|---|---|
| Ничего не загружается | ✓ | ✗ | Зависит |
| Группированный обзор | ✓ | ✓ | ✗ |
| Отмечает неиспользуемые схемы | ✓ | ✗ | ✗ |
| Не требует установки | ✓ | ✗ | ✓ |
Визуализатор спецификаций OpenAPI помогает быстро разобраться в незнакомом API; линтер в CI — то, что не даёт спецификации отойти от кода.