Выбор исходных данных и способа обработки

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

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

Порядок действий

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

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

Практический пример

{ "valid": true, "errors": [], "operations": 1 }

Вход и результат
Исходные данные
{"openapi":"3.0.3","info":{"title":"Catalog","version":"1.0.0"},"paths":{"/items":{"get":{"responses":{"200":{"description":"OK"}}}}}}
Результат
{
  "valid": true,
  "errors": [],
  "operations": 1
}

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

Ограничения и проверка готового файла

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

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

Официальные требования: OpenAPI specification 3.1.1

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

Вопросы и ответы

Какие исходные данные принимает «Проверить 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 млн.

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

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