Skip to content
GenX API logo
GenX API
Orchestration for API client generation
Docs navigation

GenX API Overview

GenX API is an orchestration layer for contract-driven client and package generation. It reads OpenAPI-driven configuration, hands generator-specific work to templates, and coordinates shared lifecycle tasks around the generated package.

Current Capabilities

  • Unified config for multi-client generation.
  • First-party Orval and Kubb templates, plus explicit external template contract support.
  • First-class diff command for OpenAPI comparisons with text and JSON output.
  • Structured change classification with the current supported levels: none, documentation, additive, and structural.
  • Release manifest support that can collect diff and generation metadata into one machine-readable file.
  • Workspace and package scaffolding for monorepos, including Nx-style repository layouts.
  • Generation-time hooks and package scaffolding.
  • Optional post-generation GitHub sync and npm or GitHub Packages publish steps.
  • A publish command that creates a GitHub release when you pass explicit release metadata.

Planned Capabilities

These are planned, not shipped in the current CLI surface:

  • Breaking vs non-breaking structural diffing and deeper release intelligence.
  • Automatic SemVer selection from contract diffs.
  • Broader catalog or reporting surfaces.

Boundaries

  • Backend boundary: OpenAPI or Swagger contract.
  • Consumer boundary: generated package interface.
  • Template boundary: generator-specific mapping and artefacts.
  • Core boundary: orchestration, lifecycle, metadata, and shared workflow concerns.

Read the full boundary document in Architecture boundaries.

Current CLI Usage

For repeatable project setup:

npm install --save-dev @genxapi/cli @genxapi/template-orval
npx genxapi generate --log-level info

For one-off execution without a local install:

npx genxapi generate --log-level info

The shipped command surface is currently:

  • generate
  • diff
  • publish

genxapi is the primary command alias; @genxapi/cli remains the direct package alternative.

Templates

  • Orval template: package scaffolding plus Orval-specific client, mock, and bundling behaviour.
  • Kubb template: package scaffolding plus Kubb plugin configuration and output assembly.
  • External templates: packages or local modules that export the same template contract and keep generator-specific richness on the template side.

Next steps: read Getting Started, then Configuration, Release lifecycle, Templates, and Next steps.