docfy generate-client

Genereert een getypeerde TypeScript-client uit een OpenAPI-document, een dunne wrapper om openapi-typescript en openapi-fetch heen, geen from-scratch code-generator.

Gebruik

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

In plaats van zelf een code-generator te herbouwen, wrapt dit twee gevestigde libraries: openapi-typescript (types) en openapi-fetch (de runtime-client die ze consumeert).

Opties

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

Wat het wegschrijft

Er worden twee bestanden weggeschreven naar de outputmap:

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

De gegenereerde client gebruiken

openapi-fetch is geen dependency van nestjs-docfy zelf, want alleen de gegenereerde client.ts importeert het, dus installeer het in je eigen project:

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