OpenApi synchronisation (openapi-ts-sync)

UNDER DEVELOPMENT

Description

This script will fetch a remote openapi.json and creates the schemas and a services to have a nice typescript support for schema properties and available remote endpoints.

Table Of Contents

• Description
• Intent
• Installation
• Command
  • Run with npm
  • Options

Installation

$ npm install openapi-typescript-sync --save-dev

Todo

• write tests
• add header parameters as header parameters, now the authorization must be placed as a parameter, which does nothing and as AxiosRequestOptions.

Command

$ npm run bin/openapi-typescript-sync --schema-dir={{ schema-dir }} --route-dir={{ route-dir }}

Run with npm

Add the script to your package.json file:

1{
2  ...
3  "scripts": {
4     ...,
5     "api-sync": "npm run bin/openapi-typescript-sync --config=./openapi-ts-sync.json",
6     ...,
7  },
8  ...
9}

Config

TODO: Document

Generators

TODO: Document

Custom Generator

A custom generator is simple a class implementing the interface GeneratorInterface.

1import {GeneratorInterface} from './GeneratorInterface';
2
3export class CustomGenerator implements GeneratorInterface{
4
5	public generate(): Promise<void>{
6	    return new Promise<void>((resolve, reject) => {
7	    	// code to generate something
8        });
9    }
10}