@metaengine/openapi-react

Generate TypeScript/React services and models from OpenAPI specifications.

Install

npm install --save-dev @metaengine/openapi-react

Or use directly with npx:

npx @metaengine/openapi-react <input> <output>

Requirements

• Node.js 14.0 or later
• .NET 8.0 or later runtime (Download)

Quick start

npx @metaengine/openapi-react api.yaml ./src/api \
  --tanstack-query \
  --documentation

CLI options

| Option | Description | Default | |--------|-------------|---------| | --include-tags <tags> | Filter by OpenAPI tags (comma-separated, case-insensitive) | - | | --base-url-env <name> | Environment variable name for base URL (e.g. VITE_API_URL, NEXT_PUBLIC_API_URL) | REACT_APP_API_BASE_URL | | --service-suffix <suffix> | Service naming suffix | Api | | --options-threshold <n> | Parameter count for options object | 4 | | --documentation | Generate JSDoc comments | false | | --tanstack-query | Enable TanStack Query integration | false | | --strict-validation | Enable strict OpenAPI validation | false | | --date-transformation | Convert date strings in responses to Date objects | false | | --clean | Clean output directory (remove files not in generation) | false | | --verbose | Enable verbose logging | false | | --type-mapping <slug=target> | Override TS type for an OpenAPI format. Repeatable. See Type mapping overrides | - | | --help, -h | Show help message | - |

Type mapping overrides

Use --type-mapping to override the TS type emitted for a given OpenAPI (type, format) pair. Repeatable. Unknown slugs and unknown targets are hard errors.

| Slug | OpenAPI (type, format) | Default | --type-mapping value | |------|--------------------------|---------|------------------------| | int64 | (integer, int64) | number | int64=bigint | | decimal | (number, decimal) | number | decimal=string | | date-time | (string, date-time) | Date | date-time=string | | date | (string, date) | Date | date=string |

npx @metaengine/openapi-react api.yaml ./src/api \
  --type-mapping int64=bigint \
  --type-mapping date-time=string

See it live

Try the generator with your own spec at https://www.metaengine.eu/converters.

License

MIT

Support

For issues and feature requests, please visit: https://github.com/meta-engine/openapi-react/issues