Проверить OpenAPI

OpenAPI YAML/JSON → отчёт schema, unresolved refs, operations и конфликтов параметров.

Выберите исходный файл

Можно перетащить файл сюда

JSONYAMLYML

До 1 файла, суммарно 25 МБ. Каждое поле текста — до 1 млн символов.

Для обработки данные передаются нашему серверу. Временные рабочие файлы удаляются; история файлов не создаётся.

Данные передаются серверу для выбранной обработки. История файлов не создаётся.

Как пользоваться

Прочитайте valid/errors и проверьте локальные ссылки схемы.

  1. Подготовьте JSON OpenAPI / YAML OpenAPI. Пример показывает: проверить локальное описание OpenAPI.
  2. Запустите обработку и прочитайте диагностику.
  3. Скачайте JSON отчёт. Прочитайте valid/errors и проверьте локальные ссылки схемы.

Пример

Практический пример: Проверить OpenAPI

Исходные данные
{"openapi":"3.0.3","info":{"title":"Catalog","version":"1.0.0"},"paths":{"/items":{"get":{"responses":{"200":{"description":"OK"}}}}}}

Проверить локальное описание OpenAPI

Что получится
{
  "valid": true,
  "errors": [],
  "operations": 1
}
Форматы и ограничения

JSON и YAML проверяются валидатором Swagger Parser без загрузки внешних ссылок. Ошибки описания не показывают работоспособность реального API, поскольку запросы к endpoints не выполняются. На входе: JSON OpenAPI, YAML OpenAPI. Форматы результата: JSON отчёт.

На входе
JSON OpenAPI, YAML OpenAPI
Результат
JSON отчёт

OpenAPI YAML/JSON → отчёт schema, unresolved refs, operations и конфликтов параметров.

  • До 1 файла, суммарно 25 МБ. Каждое поле текста — до 1 млн символов.
  • Для UTF-8-файла текстовый parser допускает до 2 млн символов; поле ввода ограничено 1 млн.

Прочитайте valid/errors и проверьте локальные ссылки схемы.

Для выбранной операции данные передаются нашему серверу. Временные рабочие файлы удаляются после обработки; история пользовательских файлов не создаётся.

Для выбранной операции данные передаются нашему серверу. Временные рабочие файлы удаляются после обработки; история пользовательских файлов не создаётся.

Вопросы об инструменте

Какие исходные данные принимает «Проверить OpenAPI»?

Поддерживаются: JSON OpenAPI, YAML OpenAPI. До 1 файла, суммарно 25 МБ. Каждое поле текста — до 1 млн символов.

Что получится после обработки в «Проверить OpenAPI»?

OpenAPI YAML/JSON → отчёт schema, unresolved refs, operations и конфликтов параметров. Форматы результата: JSON отчёт.

Как проверить результат этой операции?

Прочитайте valid/errors и проверьте локальные ссылки схемы.

Какой пример помогает начать работу?

{"openapi":"3.0.3","info":{"title":"Catalog","version":"1.0.0"},"paths":{"/items":{"get":{"responses":{"200":{"description":"OK"}}}}}}. Проверить локальное описание OpenAPI Ожидаемый результат: { "valid": true, "errors": [], "operations": 1 }.

Какие ограничения нужно учитывать?

До 1 файла, суммарно 25 МБ. Каждое поле текста — до 1 млн символов. Для UTF-8-файла текстовый parser допускает до 2 млн символов; поле ввода ограничено 1 млн.

Где обрабатываются данные и сохраняется ли история?

Для выбранной операции данные передаются нашему серверу. Временные рабочие файлы удаляются после обработки; история пользовательских файлов не создаётся.

Разобраться в задаче

Все инструкции
Инструменты разработчика1 мин

Как проверить описание API OpenAPI перед импортом в инструменты разработки

OpenAPI YAML/JSON → отчёт schema, unresolved refs, operations и конфликтов параметров. Практические действия, пример и ограничения.

Читать инструкцию