Zum Hauptinhalt springen

Installation

Installiere @powerduck/x-to-openapi mit deinem bevorzugten Paketmanager.

Voraussetzungen​

  • Node.js: >= 22.12.0
  • TypeScript: optional; vollständige Typdefinitionen sind enthalten.

Installation​

npm install @powerduck/x-to-openapi
yarn add @powerduck/x-to-openapi
pnpm add @powerduck/x-to-openapi

Laufzeitabhängigkeiten​

PaketVersionVerwendung
@powerduck/openapi-parser^0.3.12Kanonische OpenAPI-Typen und Validierung der Ausgabe
curlconverter^4.12.0Parsen von curl-Befehlen in strukturierte Anfragen

Beide Abhängigkeiten werden automatisch installiert.

Modulsystem: ESM mit CJS-Unterstützung​

Das Paket deklariert "type": "module" und liefert beide Builds über einen einzigen Einstiegspunkt:

BuildBedingungDatei
ESMimport./dist/index.js
CommonJSrequire./dist/index.cjs
Typen—./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");

Das Paket deklariert "sideEffects": false, sodass Tree Shaking ungenutzte Adapter entfernt.

Konfigurationsfreie Hilfsfunktionen​

Meist reichen zwei Funktionen aus. Sie erstellen eine XToOpenApi-Instanz, registrieren den passenden Adapter und rufen convert auf:

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

Nutze die vollständige Klasse XToOpenApi, wenn du eigene Optionen, mehrere Adapter, die Erkennung "auto" oder einen eigenen Adapter benötigst.

Überprüfung​

# 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);"

Nächste Schritte​

  • Schnellstart — konvertiere einen curl-Befehl und eine Postman-Sammlung und registriere einen eigenen Adapter.
  • API-Referenz — alle Exporte und Optionen.