Skip to main content

Turn your OpenAPI specification into a beautiful TypeScript client

This package works with Node.js, Deno, BunIt is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
JSR Score
82%
Published
7 months ago (0.53.2)
Logo

OpenAPI Typescript

✨ Turn your OpenAPI specification into a beautiful TypeScript client.

Generate TypeScript interfaces, REST clients, and JSON Schemas from OpenAPI specifications.

Live demo

Features

  • works with CLI, Node.js 18+, or npx
  • supports OpenAPI 2.0, 3.0, and 3.1 specifications
  • supports both JSON and YAML input files
  • generates TypeScript interfaces, REST clients, and JSON Schemas
  • Fetch API, Axios, Angular, Node.js, and XHR clients available

Documentation

Please visit our website for documentation, guides, migrating, and more.

Sponsoring

Love Hey API? Please consider becoming a sponsor.

GitHub Integration (coming soon)

Automatically update your code when the APIs it depends on change. Find out more.

Migrating from OpenAPI Typescript Codegen?

Please read our migration guide.

Contributing

Want to get involved? Please refer to the contributing guide.

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@hey-api/openapi-ts

Import symbol

import * as openapi_ts from "@hey-api/openapi-ts";
or

Import directly with a jsr specifier

import * as openapi_ts from "jsr:@hey-api/openapi-ts";

Add Package

pnpm i jsr:@hey-api/openapi-ts
or (using pnpm 10.8 or older)
pnpm dlx jsr add @hey-api/openapi-ts

Import symbol

import * as openapi_ts from "@hey-api/openapi-ts";

Add Package

yarn add jsr:@hey-api/openapi-ts
or (using Yarn 4.8 or older)
yarn dlx jsr add @hey-api/openapi-ts

Import symbol

import * as openapi_ts from "@hey-api/openapi-ts";

Add Package

npx jsr add @hey-api/openapi-ts

Import symbol

import * as openapi_ts from "@hey-api/openapi-ts";

Add Package

bunx jsr add @hey-api/openapi-ts

Import symbol

import * as openapi_ts from "@hey-api/openapi-ts";