Inicio rápido

Esta guía muestra cómo generar un ejemplo de petición ejecutable y descubrir los generadores disponibles.

1. Instalación

npm install @powerduck/openapi-codegen

2. Generar a partir de un documento

Pasa un documento OpenAPI ya analizado junto con path, method, language y client. generate() devuelve el código fuente como cadena.

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

Equivalente en 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. Consultar los generadores disponibles

list() devuelve los descriptores de todos los generadores registrados:

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

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

Cada descriptor tiene la forma { language: string; client: string }. Los identificadores distinguen entre mayúsculas y minúsculas; cópialos exactamente de la lista de generadores de la referencia de API. Referencia de API.

También puedes seleccionar un generador mediante código:

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. Proporcionar credenciales

Usa securityValues para completar los esquemas de seguridad con nombre. Las claves deben coincidir con los nombres de los esquemas del documento:

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

5. Cambiar la URL del servidor

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

Gestión de errores

generate() lanza una excepción si faltan datos o el generador no está soportado. Al procesar documentos no confiables, captura las excepciones:

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);
}

Siguientes pasos

• Configuración — GenerateOptions, RequestIR, Generator, Plugin.
• Ejemplos — JavaScript fetch, Python requests, cURL, generadores personalizados, plugins y uso directo de RequestIR.
• Referencia de API — Todas las exportaciones.