docfy generate-client

Génère un client TypeScript typé à partir d'un document OpenAPI, un fin wrapper au-dessus d'openapi-typescript et openapi-fetch, pas un générateur de code écrit de zéro.

Usage

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

Plutôt que de réimplémenter un générateur de code, ceci enveloppe deux bibliothèques bien établies : openapi-typescript (les types) et openapi-fetch (le client runtime qui les consomme).

Options

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

Ce qui est écrit

Deux fichiers sont écrits dans le répertoire de sortie :

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

Utiliser le client généré

openapi-fetch n'est pas une dépendance de nestjs-docfy lui-même, puisque seul le client.ts généré l'importe, donc installe-le dans ton propre projet :

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