01
Уточните версию
Корневое поле определяет набор правил. В 3.1 допустим документ только с components, поэтому пустой список запросов сам по себе не доказывает ошибку.
- В примере есть общий параметр и рекурсивная модель.
Инструменты API
Форматтер OpenAPIпроверьте контракт
Вставьте JSON или YAML, изучите операции и устраните найденные ошибки перед экспортом.
Форматтер OpenAPI
Исходная спецификация OpenAPI
Результат
Подходящих конечных точек запроса нет.
Показано 0 из 0
Спецификация остаётся в этом браузере. Запросы к API и удалённым ссылкам не отправляются.
Параметры вывода
Проверяется структура документа и основные правила путей. Экспорт охватывает paths без webhook и callback. Примеры значений и реальные ответы не тестируются.
500 000 символов · глубина 60 · 50 000 узлов · 100 диагностик · 5 секунд на проверку.
Вставьте спецификацию или загрузите пример.
Копирование и скачивание относятся к выбранному представлению. Экспорт конечных точек содержит весь список независимо от поиска.
Форматтер OpenAPI помогает читать большие автоматически созданные контракты. Правильный синтаксис ещё не исключает пропущенное описание ответа или необъявленный параметр пути. Список операций позволяет понять, на что влияет ошибка.
Начните с поля версии openapi или swagger. Форматирование меняет запись документа, а проверка оценивает структуру. Поведение работающего сервиса нужно тестировать отдельно.
Зачем нужен Форматтер OpenAPI
Рассматривайте определения вместе с использующими их операциями.
Параметры с учётом наследования
Форматтер OpenAPI группирует операции по путям запросов. Раскройте запись, чтобы увидеть унаследованные параметры, тело запроса, ответы, серверы и настройки безопасности. Поиск сужает представление, но экспортирует полный список.
Непроверенные ссылки видны сразу
Локальный JSON Pointer проверяется внутри документа. Отсутствующая цель вызывает ошибку, а рекурсивная модель остаётся ссылкой. Внешние файлы не загружаются и отмечаются как непроверенные зависимости.
Три проверки перед передачей спецификации
02
Изучите итоговые параметры
Параметр операции заменяет параметр пути с тем же именем и расположением. Смотрите объединённый список, чтобы понять фактический набор входных данных.
- Без автопроверки запуск доступен по Ctrl/Cmd + Enter.
03
Выберите нужное представление
Форматированная спецификация подходит для дальнейшего редактирования. Конечные точки выгружаются полным списком JSON, а Markdown содержит документацию по операциям.
- Изменение ввода или настроек блокирует экспорт старого результата.
От структуры к документации
OpenAPI валидатор с учётом версии
Используются настоящие схемы документов Swagger 2.0 и OpenAPI 3.0/3.1. В моделях 3.1 дополнительно проверяется форма стандартных ключевых слов JSON Schema 2020-12, включая допустимые имена типов.
Согласованность путей
Обнаруживаются повторяющиеся ID операций, дубли параметров и необъявленные либо необязательные параметры пути. Поля servers, parameters и расширения x не считаются HTTP-операциями.
Форматирование Swagger и OpenAPI
JSON и YAML выводятся с отступом в два или четыре пробела. Значения, строки ссылок и версия сохраняются. Автоматической миграции definitions и параметров тела из Swagger 2.0 в OpenAPI 3 нет.
Markdown для рецензирования
Документ объединяет метаданные API, серверы, параметры, тела запросов и ответы. Описания экранируются, а блоки кода безопасно ограничиваются. HTML из спецификации не выполняется в представлении.
Границы проверки
- Один документ и известные версии
- Поддерживаются Swagger 2.0 и OpenAPI 3.0.x/3.1.x. Версия 3.2 и другие семейства спецификаций отклоняются. Локальные ссылки ведут внутрь этого документа, а не к соседним файлам на диске.
- Внешние ссылки и диалекты
- Удалённые URL и относительные файлы не загружаются. ID ресурсов, якоря, динамические ссылки и собственные диалекты вызывают предупреждение о неполной проверке. Сначала объедините зависимости в доверенной среде.
- YAML записывается заново
- Комментарии и стиль кавычек не сохраняются. Нужен один документ YAML 1.2 со строковыми ключами. Якоря, псевдонимы, слияния, собственные теги, дубли ключей и числа с потерей точности отклоняются.
- Список охватывает запросы
- Экспортируются операции под paths. Webhook и callback проверяются структурно, но не входят в список и семантические проверки путей. Примеры, реальные ответы, авторизация и бизнес-правила требуют отдельных тестов.
- Ограниченный объём работы
- Ввод: до 500 000 символов, глубины 60 и 50 000 узлов. Обработка прекращается при превышении 100 диагностик, 2 000 000 символов результата или пяти секунд. Крупный контракт следует разделить для проверки.
Вопросы про Форматтер OpenAPI
Поддерживаются спецификации JSON и YAML?
Да. Формат вывода можно выбрать независимо от ввода. В YAML ключи, включая коды ответов, должны быть строками. Комментарии и исходный стиль кавычек не сохраняются.
Спецификация проверяется полностью по схеме OpenAPI?
Проверяется структура документа, стандартные ключевые слова, локальные ссылки и основные правила путей. Внешние зависимости и расширенные диалекты явно отмечаются как непроверенные. Реальные ответы и примеры данных не тестируются.
Какие версии распознаются?
Swagger 2.0 и OpenAPI 3.0.x/3.1.x. Правила выбираются по корневому полю. Неподдерживаемые версии, например 3.2, не обрабатываются по правилам другой версии.
Моя спецификация куда-либо загружается?
Нет. Разбор и проверка выполняются в worker браузера; URL из документа тоже не вызываются. После перезагрузки страницы ввод не восстанавливается автоматически.
Можно скачать форматированный результат?
Да. Выбранное представление определяет экспорт спецификации, полного списка конечных точек или Markdown. При ошибках и устаревшем результате экспорт недоступен, пока проверка не завершится заново.
Документ дал неожиданный результат?
Проверьте следующий контракт
Форматтер OpenAPI поможет уточнить версию, устранить замечания и передать коллегам нужное представление.
Форматирование сохраняет исходную версию спецификации.