Aller au contenu principal

Installation

Installez @powerduck/x-to-openapi avec votre gestionnaire de paquets préféré.

Prérequis​

  • Node.js: >= 22.12.0
  • TypeScript : facultatif ; toutes les définitions de types sont incluses.

Installation​

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

Dépendances d’exécution​

PaquetVersionUsage
@powerduck/openapi-parser^0.3.12Types canoniques OpenAPI et validation de la sortie
curlconverter^4.12.0Analyse des commandes curl en requêtes structurées

Les deux dépendances sont installées automatiquement.

Système de modules : ESM avec compatibilité CJS​

Le paquet déclare "type": "module" et fournit les deux builds depuis un point d’entrée unique :

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

Le paquet déclare "sideEffects": false, ce qui permet au tree shaking de supprimer les adaptateurs inutilisés.

Fonctions sans configuration​

La plupart des utilisateurs n’ont besoin que de deux fonctions. Elles créent une instance de XToOpenApi, enregistrent l’adaptateur correspondant et appellent convert :

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

Utilisez la classe XToOpenApi complète pour des options personnalisées, plusieurs adaptateurs, la détection "auto" ou un adaptateur personnalisé.

Vérification​

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

Étapes suivantes​