docfy generate-client

Generuje typowany klient TypeScript z dokumentu OpenAPI, cienką nakładkę na openapi-typescript i openapi-fetch, a nie generator kodu od zera.

Użycie

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

Zamiast reimplementować generator kodu, ta komenda opiera się na dwóch ugruntowanych bibliotekach: openapi-typescript (typy) i openapi-fetch (klient runtime, który je konsumuje).

Opcje

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

Co zapisuje

Do katalogu wyjściowego zapisywane są dwa pliki:

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

Używanie wygenerowanego klienta

openapi-fetch nie jest zależnością samego nestjs-docfy, bo importuje ją wyłącznie wygenerowany client.ts, więc zainstaluj ją we własnym projekcie:

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