Passa al contenuto principale

Installazione

Requisiti​

  • Node.js: >= 22.12.0 (dichiarato nel campo engines del pacchetto).
  • Un gestore di pacchetti: npm, yarn o pnpm.

Il pacchetto include build ESM (dist/index.js) e CommonJS (dist/index.cjs), con dichiarazioni TypeScript (dist/index.d.ts). Non servono pacchetti @types aggiuntivi.

Installazione globale (consigliata per la CLI)​

L’installazione globale aggiunge l’eseguibile openapi-cli al tuo PATH:

npm install -g @powerduck/openapi-cli

Verifica l’eseguibile:

openapi-cli --help

Installazione nel progetto (consigliata per la CI)​

Fissa la versione nel progetto affinché la CI usi una versione nota:

npm install --save-dev @powerduck/openapi-cli

Poi richiama l’eseguibile tramite il gestore di pacchetti:

npx openapi-cli --spec openapi.json
# or
pnpm exec openapi-cli --spec openapi.json

Esecuzione occasionale con npx​

Senza installazione preventiva:

npx @powerduck/openapi-cli --spec openapi.json

Struttura del pacchetto​

Punto di ingressoPercorso
Ingresso ESMdist/index.js
Ingresso CommonJSdist/index.cjs
Definizioni dei tipidist/index.d.ts
Ingresso CLI (bin)dist/cli.js
Nome dell’eseguibileopenapi-cli

Il pacchetto dichiara "type": "module" ed espone soltanto i sottopercorsi . e ./package.json.

Importazione nel codice​

// ESM
import { runTests, resolveConfig } from "@powerduck/openapi-cli";

// CommonJS
const { runTests, resolveConfig } = require("@powerduck/openapi-cli");

Dipendenze di runtime​

Il pacchetto pubblicato dipende da:

  • @powerduck/openapi-parser (^0.3.12) — risoluzione dei riferimenti $ref interni.
  • @powerduck/openapi-request (0.2.22) — esecuzione delle richieste di protocollo.
  • commander (^12.1.0) — analisi degli argomenti della CLI.
  • https-proxy-agent (^5.0.1) — supporto proxy per il trasporto HTTP.

Passaggi successivi​

  • Guida rapida — esegui la tua prima suite di test.
  • Comandi — riferimento completo delle opzioni.