TS Swagger Typegen

The package is used to generate typescript types using Swagger documentation.

Installation

Step 1: Install ts-swagger-typegen

yarn add ts-swagger-typegen

Step 2: Create a configration file

Add a typegen.config.json with content:

{
  "dev": {
    "url": "<url_to_swagger>",
    "title": "<title>",
    "location": "<location_to_save_types>"
  }
}

Step 3: Add to scripts in package json

  "scripts": {
    "typegen": "ts-swagger-typegen"
  }

Step 4: Generate types

yarn typegen dev

You can change dev to any environment as specified in typegen.config.json

Best practices

• Always gitignore the type file
• Add configuration for all the environemnts
• Generate the type before development and during build process

TODO

• Eslint configuration
• Add tests
• Generation from multiple swagger
• Service layer code