npm NuGet v1.2.1 MIT

@metaengine/openapi-react

OpenAPI 3.x → React hooks with TanStack Query (useQuery, useMutation) and native Fetch API. Tree-shakeable, typed, React 18+.

OpenAPI 3.xMetaEngine IRTypeScript · React
Install

Pick your registry

The same generator, published to every ecosystem we support. Install however your project expects.

npmPrimary@metaengine/openapi-react
$npm install @metaengine/openapi-react
v1.2.1
NuGetMetaEngine.TypeScript.OpenApi.React
$dotnet add package MetaEngine.TypeScript.OpenApi.React
v1.2.1
Usage

Drive it from the CLI or programmatically

npm ships a zero-config CLI. NuGet ships the same generator as a C# fluent API — same options, same output.

npm · npx · CI-friendly

After install, point the CLI at your schema. It writes the generated tree to your chosen output directory.

Basic syntax
terminal
npx @metaengine/openapi-react <input> <output> [options]

Supports OpenAPI 3.0+ specifications in both JSON and YAML formats.

Quick examples
Generate from a local file
npx @metaengine/openapi-react api.yaml ./src/api
Generate from a URL
npx @metaengine/openapi-react https://api.example.com/openapi.json ./src/api
With TanStack Query and Vite
npx @metaengine/openapi-react api.yaml ./src/api \
  --tanstack-query \
  --documentation \
  --base-url-env VITE_API_URL
CLI options
Option
Description
--base-url-env <name>
Environment variable name for base URL [default: REACT_APP_API_BASE_URL]. Use VITE_ prefix for Vite, NEXT_PUBLIC_ for Next.js.
--service-suffix <suffix>
Service naming suffix [default: Api]
--tanstack-query
Enable TanStack Query integration (useQuery / useMutation)
--documentation
Generate JSDoc comments
--options-threshold <n>
Parameter count to use options object [default: 4]
--type-mapping <mapping>
Override TS type for an OpenAPI format. Repeatable. int64=bigint · decimal=string · date-time=string · date=string
--include-tags <tags>
Filter by OpenAPI tags (comma-separated, case-insensitive)
--strict-validation
Enable strict OpenAPI validation
--date-transformation
Convert date strings in responses to JavaScript Date objects
--clean
Clean output directory (remove files not in generation)
--verbose
Enable verbose logging
--help, -h
Show help message
Options reference

Every knob, documented

Every option is available on the C# fluent API as a method, and most are also exposed as CLI flags. Cross-cutting auth, headers, retries and timeouts apply across frameworks.

React Options

7
  • WithBaseUrlEnvVar(string)Environment variable name for base URL (default: "REACT_APP_API_BASE_URL"). Use VITE_ prefix for Vite, NEXT_PUBLIC_ for Next.js.
  • WithTanStackQuery()Generate TanStack Query hooks (useQuery / useMutation). Requires @tanstack/react-query.
  • WithMiddleware()Emit onRequest / onResponse / onError middleware hooks in the generated client
  • WithResponseDateTransformation()Convert date / date-time strings in responses to Date objects
  • WithMethodNames(Func)Custom method naming rule
  • WithDocumentation()Enable JSDoc comments
  • WithOptionsObjectThreshold(int)Parameter count for options object (default: 4)

Auth · Headers · Resilience

12
  • WithErrorHandling()Enable smart error handling based on HTTP status semantics
  • WithErrorHandling(errors => errors...)Per-status routing: ReturnNullFor(404, 403) · ReturnErrorFor(400, 422) · ThrowFor(401, 500)
  • WithBearerAuth()Bearer token from env var (default API_TOKEN) — adds Authorization header
  • WithBearerAuth(string)Bearer token from a specific env var name
  • WithBearerAuth(string, string)Bearer token with custom header name
  • WithBasicAuth(string, string)HTTP Basic auth from username + password env vars
  • WithCustomHeader(string, string)Static header from env var. Repeatable.
  • WithTimeout(double)Request timeout in seconds for all operations
  • WithTimeout(double?, double?, double?, double?)Granular timeout: seconds · connect · read · write
  • WithRetries()Retries with exponential backoff (default status 429, 503)
  • WithRetries(int, double, double)Retries with max attempts, base delay, max delay
  • WithRetries(int, double, double, int[])Retries with full custom settings including status codes

OpenAPI Filtering

3
  • WithStrictValidation()Enable strict OpenAPI validation
  • WithOperationFilter(Func)Filter operations by predicate
  • WithHeaderFilter(Func)Filter header parameters

Naming Transformations

3
  • Types(Func)Transform type names
  • Paths(Func)Transform output paths
  • FileNames(Func)Transform file names

File Management

5
  • CleanDestination()Clean output directory before generation
  • AlwaysOverwrite()Always overwrite existing files
  • OnlyWhenModelChanged()Update only when model changes
  • OnlyWhenNew()Write only new files, preserve existing
  • CleanDirectories(...)Clean specific subdirectories

Diagnostics

1
  • EnableVerboseLogging()Enable detailed logging
Features

Why this package is different

Deterministic output
Same spec + same options produce byte-identical files. Safe to commit, safe to diff in review, safe to cache in CI.
Tree-shakeable
One file per tag (or per operation) means bundlers drop unused code at build time. No runtime dispatch table.
Zero runtime
Validation and clients opt in. The default emit is pure types with no dependency surface beyond your HTTP lib.
Flexible naming
Case conventions configurable per role — types, properties, operations, enums. Idiomatic in the target by default.
Type resolution
Discriminated unions for oneOf, proper nullability, bigint when the spec mandates it, refs flattened only when safe.
Semver-honest
Spec diff drives the version bump. Additive changes = minor, removed ops = major. Never a surprise in your lockfile.