Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 923 Bytes

README.md

File metadata and controls

24 lines (21 loc) · 923 Bytes

OpenAPI Typescript Generator

This library allows generating code for Typescript and OpenAPI specs. The main feature of this library is the generation of API Clients in Typescript from OpenAPI specs. One of the other features this library supports is generating OpenAPI enums! from Typescript code.

Installation

npm install -g open-ts

Usage

1/ API Agent

Usage

open-ts gen-agent <path/to/your-openapi-specs-file.yml> <path/to/generated/your-ts-file.ts>

2/ OpenAPI enums

This command parses files of the <path/to/dir> and generated OpenAPI specs enums for Typescript enums and Object literals annotated with const keyword. To exclude an object declaration, use the leading comment:

/* open-ts: ignore-convert-enums */

Usage

open-ts convert-enums <path/to/dir> <path/to/generated/your-yaml-file.yml>