docfy generate-client

Generiert einen typisierten TypeScript-Client aus einem OpenAPI-Dokument – ein schlanker Wrapper um openapi-typescript und openapi-fetch, kein Codegenerator von Grund auf.

Verwendung

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

Statt einen Codegenerator neu zu erfinden, wrappt das hier zwei etablierte Bibliotheken: openapi-typescript (Typen) und openapi-fetch (der Runtime-Client, der sie konsumiert).

Optionen

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

Was geschrieben wird

Zwei Dateien werden ins Ausgabeverzeichnis geschrieben:

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

Den generierten Client verwenden

openapi-fetch ist keine Abhängigkeit von nestjs-docfy selbst, da nur die generierte client.ts es importiert – installiere es also in deinem eigenen Projekt:

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