docfy generate-client

Genera un client TypeScript tipizzato da un documento OpenAPI, un thin wrapper su openapi-typescript e openapi-fetch, non un generatore di codice da zero.

Utilizzo

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

Invece di reimplementare un generatore di codice, questo avvolge due librerie consolidate: openapi-typescript (i tipi) e openapi-fetch (il client a runtime che li consuma).

Opzioni

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

Cosa scrive

Vengono scritti due file nella directory di output:

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

Usare il client generato

openapi-fetch non è una dipendenza di nestjs-docfy stesso, dato che solo il client.ts generato lo importa, quindi installalo nel tuo progetto:

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