JSPM

  • Created
  • Published
  • Downloads 507457
  • Score
    100M100P100Q190447F
  • License MIT

Turn your OpenAPI specification into a beautiful TypeScript client

Package Exports

  • @hey-api/openapi-ts
  • @hey-api/openapi-ts/dist/node/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hey-api/openapi-ts) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Logo

OpenAPI Typescript

✨ Turn your OpenAPI specification into a beautiful TypeScript client.

openapi-ts allows you to create TypeScript interfaces, REST clients, and JSON Schemas from an OpenAPI specification.

Features

  • use with CLI, Node.js, or npx
  • export TypeScript interfaces from OpenAPI v2.0, v3.0, and v3.1 specifications
  • support JSON or YAML input files
  • support external references using json-schema-ref-parser
  • create fetch, axios, angular, node.js, or xhr REST clients
  • export JSON Schemas from OpenAPI specifications
  • abortable requests through cancellable promise pattern

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.

Documentation

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

Contributing

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