Ana içeriğe geç

Kurulum

@powerduck/x-to-openapi paketini tercih ettiğiniz paket yöneticisiyle kurun.

Gereksinimler​

  • Node.js: >= 22.12.0
  • TypeScript: isteğe bağlıdır; tüm tür tanımları pakete dahildir.

Kurulum​

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

Çalışma zamanı bağımlılıkları​

PaketSürümKullanım
@powerduck/openapi-parser^0.3.12Standart OpenAPI türleri ve çıktı doğrulaması
curlconverter^4.12.0curl komutlarını yapılandırılmış isteklere ayrıştırma

Her iki bağımlılık otomatik kurulur.

Modül sistemi: ESM öncelikli, CJS destekli​

Paket "type": "module" bildirir ve tek bir giriş noktasından iki derlemeyi de sunar:

DerlemeKoşulDosya
ESMimport./dist/index.js
CommonJSrequire./dist/index.cjs
Türler—./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");

Paket "sideEffects": false bildirir; böylece tree shaking kullanılmayan bağdaştırıcıları kaldırır.

Ayar gerektirmeyen yardımcı işlevler​

Çoğu kullanıcıya iki işlev yeter. Bu işlevler bir XToOpenApi örneği oluşturur, uygun bağdaştırıcıyı kaydeder ve convert çağırır:

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

Özel seçenekler, birden fazla bağdaştırıcı, "auto" algılama veya özel bağdaştırıcı gerektiğinde tam XToOpenApi sınıfını kullanın.

Doğrulama​

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

Sonraki adımlar​

  • Hızlı başlangıç — bir curl komutunu ve Postman koleksiyonunu dönüştürün, özel bağdaştırıcı kaydedin.
  • API başvurusu — tüm dışa aktarımlar ve seçenekler.