Cài đặt

Cài @powerduck/x-to-openapi bằng trình quản lý gói bạn thích.

Yêu cầu

• Node.js: >= 22.12.0
• TypeScript: tùy chọn; gói kèm đầy đủ định nghĩa kiểu.

Cài đặt

npm install @powerduck/x-to-openapi

yarn add @powerduck/x-to-openapi

pnpm add @powerduck/x-to-openapi

Phụ thuộc lúc chạy

Gói	Phiên bản	Mục đích
@powerduck/openapi-parser	^0.3.12	Kiểu OpenAPI chuẩn và xác thực đầu ra
curlconverter	^4.12.0	Phân tích lệnh curl thành yêu cầu có cấu trúc

Cả hai phụ thuộc đều được cài tự động.

---

Hệ thống mô-đun: ưu tiên ESM, hỗ trợ CJS

Gói khai báo "type": "module" và cung cấp cả hai bản dựng qua cùng một điểm vào:

Bản dựng	Điều kiện	Tệp
ESM	import	./dist/index.js
CommonJS	require	./dist/index.cjs
Kiểu	—	./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");

Gói khai báo "sideEffects": false, nên tree shaking có thể loại bỏ bộ chuyển đổi không dùng.

---

Hàm tiện ích không cần cấu hình

Hầu hết người dùng chỉ cần hai hàm. Chúng tạo một thể hiện XToOpenApi, đăng ký bộ chuyển đổi tương ứng và gọi convert:

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

Dùng lớp XToOpenApi đầy đủ khi cần tùy chọn riêng, nhiều bộ chuyển đổi, phát hiện "auto" hoặc bộ chuyển đổi tùy chỉnh.

---

Kiểm tra

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

---

Bước tiếp theo

• Bắt đầu nhanh — chuyển đổi lệnh curl và bộ sưu tập Postman, rồi đăng ký bộ chuyển đổi tùy chỉnh.
• Tham khảo API — tất cả mục xuất và tùy chọn.