# @spec2ts/openapi > Utility to convert OpenAPI v3 specifications to Typescript using TypeScript native compiler Latest version **4.1.1** (published 2026-09-07) · MIT license · 0 weekly downloads ## Install ```sh npm install @spec2ts/openapi pnpm add @spec2ts/openapi yarn add @spec2ts/openapi bun add @spec2ts/openapi ``` Provides the command `oapi2ts`. ## 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-04-24 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 6 | | Unpacked size | 20.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 24 | | Author | Touchify | | Maintainers | mluce, mtrimolet | | Keywords | ast, compile, compiler, interface, openapi, openapi3, share, spec, spec2ts, specification, transpile, typescript, typing | ## Links - npm: https://www.npmjs.com/package/@spec2ts/openapi - 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 ## Dependencies (6) - [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/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.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.8 — 2022-09-21 - 2.0.0-beta.7 — 2022-07-29 - 2.0.0-beta.6 — 2022-01-27 - 2.0.0-beta.5 — 2021-11-03 - … 17 more at https://npm.io/package/@spec2ts/openapi/versions ## README # @spec2ts/openapi [![NPM version](https://img.shields.io/npm/v/@spec2ts/openapi.svg?style=flat-square)](https://npmjs.org/package/@spec2ts/openapi) [![NPM download](https://img.shields.io/npm/dm/@spec2ts/openapi.svg?style=flat-square)](https://npmjs.org/package/@spec2ts/openapi) [![Build Status](https://travis-ci.org/touchifyapp/spec2ts.svg?branch=master)](https://travis-ci.org/touchifyapp/spec2ts) `@spec2ts/openapi` is an utility to create TypeScript types from OpenAPI v3 specification. Unlike other code generators `@spec2ts/openapi` 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` 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 ``` ## CLI Usage ```bash oapi2ts [options] Generate TypeScript types from OpenAPI specification Positionals: input Path to OpenAPI Specification(s) to convert to TypeScript [string] Options: --version Show version number [boolean] --help Show help usage [boolean] --output, -o Output directory for generated types [string] --cwd, -c Root directory for resolving $refs [string] --avoidAny Avoid the `any` type and use `unknown` instead [boolean] --enableDate Build `Date` for format `date` and `date-time` [boolean] --banner, -b Comment prepended to the top of each generated file [string] ``` ## Programmatic Usage ```typescript import { printer } from "@spec2ts/core"; import { parseOpenApiFile } from "@spec2ts/openapi"; async function generateSpec(path: string): Promise { const result = await parseOpenApiFile(path); return printer.printNodes(result); } ``` ## Implementations - [x] Types for parameters: - [x] path - [x] header - [x] query - [x] cookie - [x] Types for requestBody - [x] Types for responses - [x] Automatic naming - [x] From operationId - [x] From path - [x] Parameters merging - [x] From path item - [x] From operation - [x] Override from operation - [x] [Schema references](http://json-schema.org/latest/json-schema-core.html#rfc.section.7.2.2) - [x] Local (filesystem) schema references - [x] External (network) schema references - [x] Modular architecture - [x] Import local references - [x] Embed external references ## 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 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._