@openapi-client/transformer v0.8.1

openapi-client

Project in progress.

Best way to start is look on generated petstore client.

Motivation

Recently i start using official OpenAPI Generator but there was drawbacks:

• inline schemas without exact name
• multiple client generators (axios, fetch, etc...)

In our company we using OpenAPI more and more, and clients are needed like on backend also in frontend.

This project have those goals:

• only OpenAPI 3.0. is supported (no planned support for 2.)
• client is very simple, logic free
• generate clean clients with all types
• interfaces must well named and predicable
• inline interface (related to apis) using namespaces
• well supported schema types like anyOf, oneOf, allOf, array

For now clients dont implement request sending, they have just dependency on interface that execute requests. In future i plan to add packages @openapi-client/adatper-axios and @openapi-client/adapter-fetch for request processing.

Usage

npm i @openapi-client/generator @openapi-client/compiler-typescript

import { generateClients } from '@openapi-client/generator'

generateClients(require('./petstore.json'), [{
	name: 'typescript',
	outDir: __dirname + '/out/typescript',
	compilerOptions: {
		npmName: 'swagger-petstore-client',
		npmAuthor: 'Swagger',
		clientClass: 'SwaggerPetstoreClient',
	}
}])

Development

There is lot of work todo, like write tests, docs, adapters, build from url and so on to make it ready for production usage. If anyone like this idea or output, cooperation is welcome.

I'm not strong with open-source, so if there is anybody who want to maintain open-source i really appreciate your help.

Current implementation notes:

• for now only json responses are supported
• schema title is preferred as interface name

npm install
npm run bootstrap
npm run build:watch