Установка

Установите @powerduck/x-to-openapi удобным менеджером пакетов.

Требования

• Node.js: >= 22.12.0
• TypeScript: необязателен; полные определения типов включены в пакет.

Установка

npm install @powerduck/x-to-openapi

yarn add @powerduck/x-to-openapi

pnpm add @powerduck/x-to-openapi

Зависимости времени выполнения

Пакет	Версия	Назначение
@powerduck/openapi-parser	^0.3.12	Канонические типы OpenAPI и проверка результата
curlconverter	^4.12.0	Разбор команд curl в структурированные запросы

Обе зависимости устанавливаются автоматически.

---

Модульная система: ESM с поддержкой CJS

Пакет объявляет "type": "module" и предоставляет обе сборки через одну точку входа:

Сборка	Условие	Файл
ESM	import	./dist/index.js
CommonJS	require	./dist/index.cjs
Типы	—	./dist/index.d.ts

// ESM (Node.js, bundlers)
import { curlToOpenApi, postmanToOpenApi } from "@powerduck/x-to-openapi";

// CommonJS (require)
const { curlToOpenApi, postmanToOpenApi } = require("@powerduck/x-to-openapi");

Пакет объявляет "sideEffects": false, поэтому tree shaking удаляет неиспользуемые адаптеры.

---

Вспомогательные функции без настройки

Большинству пользователей достаточно двух функций. Они создают экземпляр XToOpenApi, регистрируют подходящий адаптер и вызывают convert:

import {
  curlToOpenApi,    // string | string[]  → OpenAPI 3.2
  postmanToOpenApi, // collection object | JSON string → OpenAPI 3.2
} from "@powerduck/x-to-openapi";

Используйте полный класс XToOpenApi, если нужны собственные параметры, несколько адаптеров, определение "auto" или свой адаптер.

---

Проверка

# Check the installed version
npm list @powerduck/x-to-openapi

# Verify the package loads and the helpers exist
node -e "const x = require('@powerduck/x-to-openapi'); console.log(typeof x.curlToOpenApi, typeof x.postmanToOpenApi, typeof x.XToOpenApi);"

---

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

• Быстрый старт — преобразуйте команду curl и коллекцию Postman и зарегистрируйте собственный адаптер.
• Справочник API — все экспорты и параметры.