Skip to content

hey-api/openapi-ts

Repository files navigation

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, or npx
  • supports OpenAPI 2.0, 3.0, and 3.1 specifications
  • supports both JSON and YAML input files
  • supports external references using json-schema-ref-parser
  • generates TypeScript interfaces, REST clients, and JSON Schemas
  • Fetch API, Axios, Angular, Node.js, and XHR clients available
  • abortable requests through cancellable promise pattern

Documentation

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

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.