Swagger-Typescript-Converter

This module can convert an Swagger description into a TypeScript client.

Installation

npm i @nowak-ds/swagger-typescript-converter

Configuration

Create file called convert-config.json in your porjects root directory. The file should look like this.

{
    "targetDir": "generated-clients",
    "sourceDir": "swagger-desc",
    "env": "node",
    "sources": [
        {
            "name": "Swagger",
            "url": "https://petstore.swagger.io/v2/swagger.json",
            "headers": {
                ...
            }
        }
    ]
}

All properties in this object are optional.

targetDir

This is the folder where the created clients are stored when they have been successfully generated. If no targetDir was set the created clients will be created in the directory generated-clients.

sourceDir

In this folder you can place *.json files which include the swagger schemes of the apis.

env

Here you tell the module if the created clients are used in node or in _browser. Default is node

sources

This property takes an array of objects where you can set the name of the API and where the URL where the swagger description is available.

Execute

Simply call:

node node_modules/@nowak-ds/swagger-typescript-converter/index.js

Or create a new script in your package.json file:

"scripts": {
    "update-types": "node node_modules/@nowak-ds/swagger-typescript-converter/index.js"
 }