# @spec2ts/openapi-client

> Utility to convert OpenAPI v3 specifications to Typescript HTTP client using TypeScript native compiler

Latest version **4.1.1** (published 2026-09-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @spec2ts/openapi-client
pnpm add @spec2ts/openapi-client
yarn add @spec2ts/openapi-client
bun add @spec2ts/openapi-client
```

Provides the command `oapi2tsclient`.

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.1.1 |
| Published | 2026-09-07 |
| First published | 2020-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 39.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Touchify |
| Maintainers | mluce, mtrimolet |
| Keywords | ast, client, compile, compiler, http, interface, openapi, openapi3, rest, share, spec, spec2ts, specification, transpile, typescript, typing |

## Links

- npm: https://www.npmjs.com/package/@spec2ts/openapi-client
- Repository: https://github.com/touchifyapp/spec2ts
- Homepage: https://github.com/touchifyapp/spec2ts/blob/master/packages/openapi#readme
- Issues: https://github.com/touchifyapp/spec2ts/issues
- npm.io page: https://npm.io/package/@spec2ts/openapi-client

## Dependencies (7)

- [yargs](https://npm.io/package/yargs.md) ^18.0.0
- [typescript](https://npm.io/package/typescript.md) ^6.0.0
- [openapi3-ts](https://npm.io/package/openapi3-ts.md) ^4.6.0
- [@spec2ts/core](https://npm.io/package/@spec2ts/core.md) ^4.1.1
- [@spec2ts/openapi](https://npm.io/package/@spec2ts/openapi.md) ^4.1.1
- [@spec2ts/jsonschema](https://npm.io/package/@spec2ts/jsonschema.md) ^4.1.1
- [@apidevtools/json-schema-ref-parser](https://npm.io/package/@apidevtools/json-schema-ref-parser.md) ^10.1.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 4.1.1 (latest) — 2026-09-07
- 4.1.0 — 2026-09-07
- 4.0.3 — 2026-07-17
- 4.0.2 — 2026-07-17
- 4.0.1 — 2026-07-09
- 4.0.0 — 2026-07-09
- 3.1.3 — 2025-04-10
- 3.1.2 — 2023-10-23
- 3.1.1 — 2023-10-03
- 3.1.0 — 2023-09-25
- 3.0.1 — 2023-09-12
- 3.0.0 — 2023-09-12
- 2.0.0 — 2023-09-08
- 2.0.0-beta.13 — 2022-09-21
- 2.0.0-beta.12 — 2022-08-23
- … 27 more at https://npm.io/package/@spec2ts/openapi-client/versions

## README

# @spec2ts/openapi-client

[![NPM version](https://img.shields.io/npm/v/@spec2ts/openapi-client.svg?style=flat-square)](https://npmjs.org/package/@spec2ts/openapi-client)
[![NPM download](https://img.shields.io/npm/dm/@spec2ts/openapi-client.svg?style=flat-square)](https://npmjs.org/package/@spec2ts/openapi-client)
[![Build Status](https://travis-ci.org/touchifyapp/spec2ts.svg?branch=master)](https://travis-ci.org/touchifyapp/spec2ts)

`@spec2ts/openapi-client` is an utility to create a TypeScript HTTP Client with entity types from OpenAPI v3 specification. Unlike other code generators `@spec2ts/openapi-client` does not use templates to generate code but uses TypeScript's built-in API to generate and pretty-print an abstract syntax tree (AST).

## Features

- **AST-based:** Unlike other code generators `@spec2ts/openapi-client` does not use templates to generate code but uses TypeScript's built-in API to generate and pretty-print an abstract syntax tree.
- **Tree-shakeable:** Individually exported types allows you to bundle only the ones you actually use.
- **YAML or JSON:** Use YAML or JSON for your OpenAPI v3 specification.
- **External references:** Resolves automatically external references and bundle or import them in generated files.
- **Implementation agnostic:** Use generated types in any projet or framework.

## Installation

Install in your project:

```bash
npm install @spec2ts/openapi-client
```

## CLI Usage

```
oapi2tsclient <input..>

Generate TypeScript HTTP client from OpenAPI specification

Positionals:
  input  Path to OpenAPI Specification(s) to convert to TypeScript HTTP client
                                                                        [string]

Options:
  --version         Show version number                                [boolean]
  --help            Show help usage                                    [boolean]
  --output, -o      Output file for generated client                    [string]
  --cwd, -c         Root directory for resolving $refs                  [string]
  --avoidAny        Avoid the `any` type and use `unknown` instead     [boolean]
  --inlineRequired  Create a method argument for each required parameter
                                                                       [boolean]
  --importFetch     Use a custom fetch implementation
                      [choices: "node-fetch", "cross-fetch", "isomorphic-fetch"]
  --packageName     Generate a package.json with given name             [string]
  --packageVersion  Sets the version of the package.json                [string]
  --packageAuthor   Sets the author of the package.json                 [string]
  --packageLicense  Sets the license of the package.json                [string]
  --packagePrivate  Sets the package.json private                      [boolean]
  --banner, -b      Comment prepended to the top of each generated file [string]
```

## Programmatic Usage

```typescript
import { printer } from "@spec2ts/core";
import { generateClientFile } from "@spec2ts/openapi-client";

async function generate(path: string): Promise<string> {
    const result = await generateClientFile(path);
    return printer.printNodes(result);
}
```

## Compatibility Matrix

| TypeScript version | spec2ts version |
| ------------------ | --------------- |
| v3.x.x             | v1              |
| v4.x.x             | v2              |
| v5.x.x             | v3              |
| v6.x.x             | v4              |

## License

This project is under MIT License. See the [LICENSE](LICENSE) file for the full license text.

---
_Source: https://npm.io/package/@spec2ts/openapi-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
