Lewati ke konten utama

Instalasi

Persyaratan​

  • Node.js: >= 22.12.0 (dinyatakan dalam kolom engines paket).
  • Pengelola paket: npm, yarn, atau pnpm.

Paket menyediakan build ESM (dist/index.js) dan CommonJS (dist/index.cjs), beserta deklarasi TypeScript (dist/index.d.ts). Tidak diperlukan paket @types tambahan.

Instalasi global (disarankan untuk CLI)​

Instalasi global membuat program openapi-cli tersedia melalui PATH Anda:

npm install -g @powerduck/openapi-cli

Periksa programnya:

openapi-cli --help

Instalasi dalam proyek (disarankan untuk CI)​

Tetapkan versi dalam proyek agar CI menggunakan rilis yang diketahui:

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

Lalu jalankan perintah melalui pengelola paket:

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

Sekali jalan dengan npx​

Tanpa instalasi sebelumnya:

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

Struktur paket​

Titik masukJalur
Titik masuk ESMdist/index.js
Titik masuk CommonJSdist/index.cjs
Definisi tipedist/index.d.ts
Titik masuk CLI (bin)dist/cli.js
Nama programopenapi-cli

Paket menyatakan "type": "module" dan hanya menyediakan subjalur . serta ./package.json.

Impor dalam kode​

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

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

Dependensi runtime​

Paket yang dipublikasikan bergantung pada:

  • @powerduck/openapi-parser (^0.3.12) — penyelesaian referensi $ref internal.
  • @powerduck/openapi-request (0.2.22) — eksekusi permintaan protokol.
  • commander (^12.1.0) — penguraian argumen CLI.
  • https-proxy-agent (^5.0.1) — dukungan proksi untuk transport HTTP.

Langkah berikutnya​

  • Mulai cepat — jalankan rangkaian pengujian pertama Anda.
  • Perintah — referensi lengkap opsi.