Быстрый старт

В этом руководстве показано, как создать исполняемый пример запроса и найти доступные генераторы.

1. Установка

npm install @powerduck/openapi-codegen

2. Генерация из документа

Передайте уже разобранный документ OpenAPI и нужные path, method, language, client. generate() возвращает исходный код в виде строки.

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

Эквивалент для 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. Список доступных генераторов

list() возвращает дескрипторы всех зарегистрированных генераторов:

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

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

Формат каждого дескриптора: { language: string; client: string }. Идентификаторы чувствительны к регистру; используйте точные значения из списка генераторов в справочнике API. Справочник API.

Генератор можно выбрать программно:

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. Передача учётных данных

Используйте securityValues, чтобы заполнить именованные схемы безопасности. Ключи должны совпадать с именами схем в документе:

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

5. Переопределение URL сервера

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

Обработка ошибок

generate() выбрасывает исключение при отсутствии входных данных или неподдерживаемом генераторе. При обработке недоверенных документов перехватывайте исключения:

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

Следующие шаги

• Настройка — GenerateOptions, RequestIR, Generator, Plugin.
• Примеры — JavaScript fetch, Python requests, cURL, собственный генератор, плагин и прямое использование RequestIR.
• Справочник API — Все экспорты.