docfy generate-client

Gera um client TypeScript tipado a partir de um documento OpenAPI, uma casca fina sobre openapi-typescript e openapi-fetch, não um gerador de código do zero.

Uso

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

Em vez de reimplementar um gerador de código, isso embrulha duas bibliotecas bem estabelecidas: openapi-typescript (tipos) e openapi-fetch (o client em runtime que os consome).

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

O que é escrito

Dois arquivos são escritos no diretório de saída:

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

Usando o client gerado

openapi-fetch não é dependência do nestjs-docfy em si, já que só o client.ts gerado o importa, então instale no seu próprio projeto:

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