Swagger Express Validator

A Swagger validator and router for Express.js

Table of contents

• Setup
• API
• Sample
• Example

Setup

1npm install --save-dev @jdes/swagger-express-validator

API

App.start(options: Object): Promise.<express.App>

Start the server.

Options

app An Express' app created with express()

• type: express.App
• required: false
• default: express()

Example:

1const app = express();
2const options = {
3  app: app
4};

hooks A list of middleware' hooks

• type: Object.<{before: Function, after: Function}>
• required: false
• default: {}

A list of hooks for every used middlewares:

• swaggerRouter: Get the right method for the current route
• requestHandler: Check parameters, and default response
• requestPerformer: Execute the controller's method with the req
• responseValidator: Validate the req.response with the associated schema
• responseSender: Get the req.response object and send it
• errorHandler: Error middleware

Example:

1const options = {
2  hooks: {
3    requestHandler: {
4      before: (req, res, next) => {
5        console.log("Hello World!");
6        next();
7      }
8    },
9    errorHandler: {
10      after: (req, res, next) => {
11        console.error("Arrrghhh");
12        next();
13      }
14    }
15  }
16};

logger A Logger

• type: winston.Logger
• required: false
• default: winston

Example:

1const options = {
2  logger: winston
3};

logLevel The logger's log level

• type: string
• required: false
• default: options.logger.level || info

Useful if you don't pass a logger.

Example:

1const options = {
2  logLevel: 'debug'
3};

paths The required paths

• type: Object.<string>
• required: true

Example:

1const options = {
2  paths: {
3    controllers: path.join(__dirname, "controller"),
4    swagger: path.join(__dirname, "swagger", "swagger.json")
5  }
6};

HttpError: Error

Parent class of the validator's errors.

Sample

A sample is available to help ou to write your own app with swagger-express-validator.

Example

1const App = require("@jdes/swagger-express-validator").App;
2const path = require("path");
3const logger = require("winston");
4
5const options = {
6  logger,
7  paths: {
8    controllers: path.join(__dirname, "controller"),
9    swagger: path.join(__dirname, "swagger", "swagger.json")
10  }
11};
12
13App.start(options)
14  .then((app) => {
15    app.listen(8080, () => {
16      logger.info(`Server launched on 8080`);
17    });
18  })
19  .catch((error) => {
20    logger.critical(error);
21  });