docfy generate-client

Genera un cliente TypeScript tipado a partir de un documento OpenAPI, una capa fina sobre openapi-typescript y openapi-fetch, no un generador de código desde cero.

Uso

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

En vez de reimplementar un generador de código, esto envuelve dos librerías ya establecidas: openapi-typescript (tipos) y openapi-fetch (el cliente en runtime que los consume).

Opciones

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

Qué escribe

Se escriben dos archivos en el directorio de salida:

  • 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.

Usando el cliente generado

openapi-fetch no es una dependencia de nestjs-docfy en sí, ya que solo el client.ts generado lo importa, así que instálalo en tu propio proyecto:

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