# openapi-ts

**Repository Path**: xiaohuntui/openapi-ts

## Basic Information

- **Project Name**: openapi-ts
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: dependabot/npm_and_yarn/angular-deps-bff0250fb9
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-25
- **Last Updated**: 2024-07-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <img width="150" height="150" src="https://heyapi.vercel.app/logo.png" alt="Logo">
  <h1 align="center"><b>OpenAPI Typescript</b></h1>
  <p align="center">✨ Turn your OpenAPI specification into a beautiful TypeScript client.</p>
</div>

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

[Live demo](https://stackblitz.com/edit/hey-api-example?file=openapi-ts.config.ts,src%2Fclient%2Fschemas.gen.ts,src%2Fclient%2Fservices.gen.ts,src%2Fclient%2Ftypes.gen.ts)

## 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](https://heyapi.vercel.app/) for documentation, guides, migrating, and more.

## GitHub Integration (coming soon)

Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.vercel.app/openapi-ts/integrations.html).

## Migrating from OpenAPI Typescript Codegen?

Please read our [migration guide](https://heyapi.vercel.app/openapi-ts/migrating.html#openapi-typescript-codegen).

## Contributing

Want to get involved? Please refer to the [contributing guide](https://heyapi.vercel.app/contributing.html).