Перейти к основному содержимому

@powerduck/openapi-parser

Преобразуйте любой документ Swagger 2.0, OpenAPI 3.0, 3.1 или 3.2 в OpenAPI 3.2 одним вызовом.

Тонкая обёртка над двумя библиотеками: @scalar/openapi-parser, @scalar/openapi-upgrader. Она не реализует заново разбор, проверку или преобразование, а объединяет их и придаёт каждой ошибке единую предсказуемую структуру с машиночитаемым кодом.

  • Имя пакета: @powerduck/openapi-parser
  • Версия:
  • Лицензия: MIT
  • Node.js: >= 22.12.0

Возможности​

  • Одна функция для всех версий — Swagger 2.0, OpenAPI 3.0.x, 3.1.x и 3.2.x преобразуются в проверенный документ 3.2.
  • Ввод в виде строк JSON и YAML — Передайте уже разобранный объект или исходную строку JSON/YAML.
  • Машиночитаемые коды ошибок — Каждый сбой представлен ошибкой OpenApiUpgradeError со значением перечисления UpgradeErrorCode.
  • Входные данные не изменяются — Перед началом преобразования выполняется глубокое копирование входных данных через structuredClone.
  • Защита от циклических ссылок — Циклы во входных данных обнаруживаются до того, как вызовут переполнение стека.
  • Проверка результата — Преобразованный документ 3.2 по умолчанию проверяется по схеме.
  • ESM и CJS — Используйте import в современном Node и сборщиках, а require() — в главном процессе Electron.

Дальнейшие шаги​