@pomgui/rest-codegen
v0.1.2
Published
Typescript code generator from Swagger/OpenApi definition file using pirest lib
Downloads
3
Readme
OpenApi typescript code generator
Another code generator from OpenAPI-specification 2.0.
The generated code uses the @pomgui/rest library as base for the REST services. This library uses decorators to improve the reading and writing of REST services source code.
Installation
npm install -g @pomgui/rest-codegen
Usage
rest-codegen --config file.conf.js [project1...]
Example
OpenApi spec input
...
/pet/findByStatus:
get:
tags:
- pet
summary: Finds Pets by status
description: Multiple status values can be provided with comma separated strings
operationId: findPetsByStatus
produces:
- application/json
parameters:
- name: status
in: query
description: Status values that need to be considered for filter
required: true
type: array
items:
type: string
enum:
- available
- pending
- sold
default: available
collectionFormat: multi
responses:
200:
description: successful operation
schema:
type: array
items:
$ref: '#/definitions/Pet'
400:
description: Invalid status value
...
Express generated code
Service files
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
*/
@PiGET('/pet/findByStatus')
async findPetsByStatus(params: FindPetsByStatusParams): Promise<Pet[]> {
if(/*condition*/false)
throw new PiError('Invalid status value', 400);
let value: Pet[] = <Pet[]> [];
/* fill 'value' here */
return value;
}
Service parameter files
/** Parameters sent in the query */
export interface FindPetsByStatusParamsQuery {
/**
* Status values that need to be considered for filter
*/
status: ('available'|'pending'|'sold')[];
}
/** Structure with ALL the operation parameters */
export interface FindPetsByStatusParams extends FindPetsByStatusParamsQuery { }
Service model files
export interface Pet {
id?: number;
category?: Category;
name: string;
photoUrls: string[];
tags?: Tag[];
status?: 'available'|'pending'|'sold';
}
Configuration file
The configuration file defines the way the code will be generated. All the projects will be altered.
Example: If you have two projects: angular and express, probably both share the same DTOs and define the same Rest API calls, so they will need be sync'ed when the swagger file changes.
Example
module.exports = {
beforeAll: 'clean',
file: './pets.swagger.yaml',
projects: [
{
name: 'server01',
type: 'express',
dir: './server',
model: {
dir: 'openapi/model',
suffix: 'Dto'
},
params: {
dir: 'openapi/params',
beforeAll: 'none',
overwrite: true,
prefix: 'Prm'
},
services: {
dir: 'openapi/service',
suffix: 'Api'
},
databasePool: {
type: 'firebird',
size: 10,
options: {
host: 'localhost',
port: 3050,
user: 'sysdba',
password: 'masterkey',
database: 'clients.fdb'
}
}
},
{
name: 'clientAngular',
type: 'angular',
dir: 'client',
...
}
}
}
Database Pool
The databasePool
only has meaning for express projects, and if it
has been configured, then the code generated will have an extra
parameter to the API operation: a database instance.
This database instance has already created a new transaction and it automatically will execute a COMMIT if the operation returns normally or it will execute a ROLLBACK if the operation ends with an exception.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to improve.
Please make sure to update tests as appropriate.