Openapi-handler

Quickstart

npm install openapi-handler

Usage Examples:

1. JSON schema generator
2. Types generator
3. API validations

JSON schema generator

Generate json schemas using open api yml.

1// schema-generator.js
2
3const { ApiHandler } = require('openapi-handler');
4
5const apihadler = new ApiHandler({
6    ymlPath: `${__dirname}/docs/openapi.yml`, // open api yml location
7    schemasOutDir: `${__dirname}/src/core/api-schemas`, // json schema out directory
8    
9    ...
10});
11
12async function generate() {
13    await apihadler
14        .createJSONSchemas()
15        .then(() => {
16            console.log('schema generated');
17        })
18        .catch(err => {
19            console.log(err);
20        });
21    
22    ...
23}
24
25generate();
26

Types generator

Generate types from open api yml using following code:

1// schema-generator.js
2
3const { ApiHandler } = require('openapi-handler');
4
5const apihadler = new ApiHandler({
6    ...
7
8    typesOutDir: `${__dirname}/src/core/types`, // typescript output directory
9});
10
11async function generate() {
12    ...
13
14    await apihadler
15        .createTypes()
16        .then(() => {
17            console.log('types generated');
18        })
19        .catch(err => {
20            console.log(err);
21        });
22}
23
24generate();
25

API validations

we provide Validator class which have validation middlewars to validate both request and response data using json schemas

you can initialize the validator as following:

1// validator.js
2import Validator from 'openapi-handler/dist/validator';
3
4export const validator = new Validator();
5
6
7// app.js
8import { validator } from './validator.js';
9
10await validator.initialize([
11    path.join(__dirname, '..', 'core/api-schemas'), // json schema directory
12]);
13
14validator.cacheValidateFunction(['ResourceIdParams#', 'DummyBase#', 'Dummy#']);
15

Request validation

1
2const RESOURCE_ID_PARAMS = 'ResourceIdParams#';
3
4router.get(
5    '/:id',
6    validator.validate({
7        params: RESOURCE_ID_PARAMS,
8    }),
9    (req, res) => {
10        res.send();
11    }
12    enhanceHandler(DummyController.getDummy, {
13        responseBody: 'Dummy#',
14    }),
15);
16

Response validation

1import { responseValidator } from 'openapi-handler/dist';
2
3const responseBody = {
4    responseBody: 'Dummy#',
5};
6
7res.send(
8    responseValidator.validateAddSerialize(
9        responseBody,
10        result,
11    ),
12);
13