https://github.com/foxel/openapi3-typescript-codegen

typescript codegen for OpenAPI 3
https://github.com/foxel/openapi3-typescript-codegen

openapi-codegen openapi3 typescript

Last synced: about 1 month ago
JSON representation

typescript codegen for OpenAPI 3

• Host: GitHub
• URL: https://github.com/foxel/openapi3-typescript-codegen
• Owner: foxel
• Created: 2018-04-04T08:14:52.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-09-15T15:01:06.000Z (over 4 years ago)
• Last Synced: 2024-11-29T16:42:15.712Z (about 1 month ago)
• Topics: openapi-codegen, openapi3, typescript
• Language: TypeScript
• Size: 29.3 KB
• Stars: 12
• Watchers: 3
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# openapi3-typescript-codegen

TypeScript code generator for OpenAPI 3.0.0

Inspired by problems with [openapi-codegen](https://github.com/Mermade/openapi-codegen)

Idea is to provide native OpenAPI 3 generator with all language-specific code being put into templates with help of generic helpers.

Currently only TypeScript language and Angular frameworks are supported.

**Work in progress**

## Usage

### Installing

`npm i -g openapi3-typescript-codegen`

### CLI

```

op3-codegen {openapi-definition.yaml} [options]

Options:

  -o, --output     Specify output directory         [string] [default: "./out/"]

  -t, --templates  Specify templates directory (pro only)               [string]

```

## Limitations in OpenAPI support (to be removed)

* support only for 'http' ('basic' and 'bearer') and 'apiKey' Security schemas,

* parameters encoder supports only style='form',explode=false encoding scheme,

* only GET, POST, PUT, DELETE operations code is generated