Mulai cepat

Panduan ini menjelaskan cara membuat contoh permintaan yang dapat dijalankan dan menemukan generator yang tersedia.

1. Instalasi

npm install @powerduck/openapi-codegen

2. Membuat kode dari dokumen

Berikan dokumen OpenAPI yang sudah diurai, beserta path, method, language, dan client tujuan. generate() mengembalikan kode sumber sebagai string.

import { generate } from "@powerduck/openapi-codegen";
import document from "./openapi.json" with { type: "json" };

const code = generate({
  document,
  path: "/pets/{id}",
  method: "get",
  language: "javascript",
  client: "fetch",
});

console.log(code);

Contoh setara dalam CommonJS:

const { generate } = require("@powerduck/openapi-codegen");
const fs = require("node:fs");

const document = JSON.parse(fs.readFileSync("./openapi.json", "utf8"));

const code = generate({
  document,
  path: "/pets",
  method: "post",
  language: "python",
  client: "requests",
});

console.log(code);

3. Melihat daftar generator

list() mengembalikan deskriptor semua generator yang terdaftar:

import { list } from "@powerduck/openapi-codegen";

for (const { language, client } of list()) {
  console.log(`${language}/${client}`);
}

Setiap deskriptor berbentuk { language: string; client: string }. Pengenal membedakan huruf besar dan kecil; gunakan persis nilai yang tercantum dalam daftar generator di referensi API. Referensi API.

Anda juga dapat memilih generator melalui kode:

import { generate, list } from "@powerduck/openapi-codegen";

const picked = list().find(
  (g) => g.language === "javascript" && g.client === "fetch",
);

if (!picked) throw new Error("Generator not available");

const code = generate({
  document,
  path: "/pets",
  method: "get",
  language: picked.language,
  client: picked.client,
});

4. Memberikan kredensial

Gunakan securityValues untuk mengisi skema keamanan bernama. Kuncinya harus sesuai dengan nama skema dalam dokumen:

const code = generate({
  document,
  path: "/pets/{id}",
  method: "get",
  language: "javascript",
  client: "fetch",
  securityValues: {
    bearerAuth: "YOUR_ACCESS_TOKEN",
    apiKey: "YOUR_API_KEY",
  },
});

5. Mengganti URL server

const code = generate({
  document,
  path: "/pets",
  method: "get",
  language: "shell",
  client: "curl",
  serverUrl: "https://staging.example.com/v1",
});

Penanganan kesalahan

generate() melempar pengecualian jika masukan tidak lengkap atau generator tidak didukung. Tangani pengecualian saat memproses dokumen yang tidak tepercaya:

try {
  const code = generate({
    document,
    path: "/pets/{id}",
    method: "get",
    language: "javascript",
    client: "fetch",
  });
  console.log(code);
} catch (error) {
  console.error("Generation failed:", error instanceof Error ? error.message : error);
}

Langkah berikutnya

• Konfigurasi — GenerateOptions, RequestIR, Generator, Plugin.
• Contoh — JavaScript fetch, Python requests, cURL, generator kustom, plugin, dan penggunaan langsung RequestIR.
• Referensi API — Semua ekspor.