docfy generate-client

Генерирует типизированный клиент на TypeScript из документа OpenAPI. Это тонкая обёртка над openapi-typescript и openapi-fetch, а не собственный генератор кода.

Использование

bash
npx nestjs-docfy generate-client --spec <path-or-url> [options]

Вместо того чтобы писать ещё один генератор кода, команда оборачивает две проверенные библиотеки: openapi-typescript для типов и openapi-fetch для клиента, который этими типами пользуется.

Параметры

OptionDefaultDescription
--spec <path|url>(required)A local openapi.json, or a URL (e.g. a running app's /api-json)
--out <path>./generated-clientOutput directory for schema.d.ts and client.ts
--root <path>.Project root directory
--quietfalseSuppress all output except errors

Что записывается

В выходной каталог записываются два файла:

  • schema.d.ts: the generated types (paths, components, operations), via openapi-typescript.
  • client.ts: a small wrapper exporting createApiClient(baseUrl), typed against schema.d.ts.

Работа с готовым клиентом

openapi-fetch не входит в зависимости самого nestjs-docfy, потому что импортирует его только сгенерированный client.ts. Поставьте его в своём проекте:

bash
npm install openapi-fetch
ts
import { createApiClient } from './generated-client/client';

const api = createApiClient('https://api.example.com');
const { data, error } = await api.GET('/users/{id}', { params: { path: { id: '123' } } });