npmpackage.info

Gathering detailed insights and metrics for openapi-typescript

Other packages similar to openapi-typescript

@octokit/openapi-types

24.0.0

Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

openapi-types

12.1.3

Types for OpenAPI documents.

openapi-typescript-helpers

0.0.15

TypeScript helpers for consuming openapi-typescript types

openapi-typescript-codegen

0.29.0

Library that generates Typescript clients based on the OpenAPI specification.

openapi-typescript

Generate TypeScript types from OpenAPI 3 specs

7.6.1

6,518

MIT

TypeScript

151.65 kB

90,399,403

Installations

npm install openapi-typescript

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

22.13.1

NPM Version

10.9.2 Score

92.7

Supply Chain

97.8

Quality

89.8

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

35

Total

1,434

Closed

300

Merged

1,099

Issues

Open

113

Total

676

Closed

563

Releases

223

openapi-typescript@7.6.1

Updated on Feb 02, 2025

openapi-typescript@7.6.0

Updated on Jan 25, 2025

openapi-react-query@0.3.0

Updated on Jan 25, 2025

openapi-metadata@0.2.0

Updated on Jan 25, 2025

openapi-react-query@0.2.10

Updated on Jan 25, 2025

swr-openapi@5.1.3

Updated on Jan 06, 2025

View All 223 releases

Contributors

190

View All 190 Contributors

Languages

TypeScript

JavaScript

CSS

HTML

Svelte

Vue

TypeScript (99.9%)

JavaScript (0.09%)

CSS (0.01%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

openapi-ts

Download Statistics

Total Downloads

90,399,403

Last Day

339,487

Last Week

1,871,148

Last Month

7,744,838

Last Year

57,687,448

GitHub Statistics

MIT License

6,518 Stars

1,361 Commits

512 Forks

26 Watchers

21 Branches

190 Contributors

Updated on Mar 14, 2025

Bundle Size

555.18 kB

Minified

151.65 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

7.6.1

Package Id

openapi-typescript@7.6.1

Unpacked Size

517.79 kB

Size

118.74 kB

File Count

NPM Version

10.9.2

Node Version

22.13.1

Published on

Feb 02, 2025

Total Downloads

Cumulative downloads

Total Downloads

90,399,403

Last Day

4.6%

339,487

Compared to previous day

Last Week

1,871,148

Compared to previous week

Last Month

30.2%

7,744,838

Compared to previous month

Last Year

131.4%

57,687,448

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

openapi-typescript turns OpenAPI 3.0 & 3.1 schemas into TypeScript quickly using Node.js. No Java/node-gyp/running OpenAPI servers necessary.

The code is MIT-licensed and free for use.

Tip: New to OpenAPI? Speakeasy’s Intro to OpenAPI is an accessible guide to newcomers that explains the “why” and “how” of OpenAPI.

Features

✅ Supports OpenAPI 3.0 and 3.1 (including advanced features like discriminators)
✅ Generate runtime-free types that outperform old school codegen
✅ Load schemas from YAML or JSON, locally or remotely
✅ Generate types for even huge schemas within milliseconds

Note: OpenAPI 2.x is supported with versions 5.x and previous

Examples

👀 See examples

Setup

This library requires the latest version of Node.js installed (20.x or higher recommended). With that present, run the following in your project:

1npm i -D openapi-typescript typescript

And in your tsconfig.json, to load the types properly:

1{
2  "compilerOptions": {
3+    "module": "ESNext", // or "NodeNext"
4+    "moduleResolution": "Bundler" // or "NodeNext"
5  }
6}

Highly recommended

Also adding the following can boost type safety:
1{
2  "compilerOptions": {
3+    "noUncheckedIndexedAccess": true
4  }
5}

Basic usage

First, generate a local type file by running npx openapi-typescript, first specifying your input schema (JSON or YAML), and where you’d like the --output (-o) to be saved:

1# Local schema
2npx openapi-typescript ./path/to/my/schema.yaml -o ./path/to/my/schema.d.ts
3# 🚀 ./path/to/my/schema.yaml -> ./path/to/my/schema.d.ts [7ms]
4
5# Remote schema
6npx openapi-typescript https://myapi.dev/api/v1/openapi.yaml -o ./path/to/my/schema.d.ts
7# 🚀 https://myapi.dev/api/v1/openapi.yaml -> ./path/to/my/schema.d.ts [250ms]

Then in your TypeScript project, import types where needed:

1import type { paths, components } from "./my-openapi-3-schema"; // generated by openapi-typescript
2
3// Schema Obj
4type MyType = components["schemas"]["MyType"];
5
6// Path params
7type EndpointParams = paths["/my/endpoint"]["parameters"];
8
9// Response obj
10type SuccessResponse =
11  paths["/my/endpoint"]["get"]["responses"][200]["content"]["application/json"]["schema"];
12type ErrorResponse =
13  paths["/my/endpoint"]["get"]["responses"][500]["content"]["application/json"]["schema"];

From here, you can use these types for any of the following (but not limited to):

Using an OpenAPI-supported fetch client (like openapi-fetch)
Asserting types for other API requestBodies and responses
Building core business logic based on API types
Validating mock test data is up-to-date with the current schema
Packaging API types into any npm packages you publish (such as client SDKs, etc.)

📓 Docs

View Docs

No vulnerabilities found.

No security vulnerabilities found.

Other packages similar to openapi-typescript

openapi-typescript

Installations

Developer Guide

Yes

ESM

22.13.1

10.9.2

Score

Pull Requests

35

1,434

300

1,099

Issues

113

676

563

Releases

Contributors

Languages

validate.email 🚀

Developer

Download Statistics

GitHub Statistics

Bundle Size

555.18 kB

151.65 kB

Maintainers

Package Meta Information

Total Downloads

90,399,403

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Features

Examples

Setup

Basic usage

📓 Docs