router-schema

router-schema is a request router schema validator based on joi in node.js, support express.js and [email protected] with koa-router.

• Installation
• Example
• API
• Change Log

Installation

npm install router-schema joi -S

Example

Create schema.js:

const Joi = require('joi');

const schema = {
  'GET /foo/bar': {
    query: {
      hello: Joi.string(),
    },
    body: {
      world: Joi.number().required(),
    },
  },
  '/bar/foo': {
    query: {
      hello: Joi.string(),
    },
    body: {
      world: Joi.number().required(),
    },
  },
};

module.exports = schema;

[email protected]

'use strict';

const Koa = require('koa');
const Router = require('koa-router');
const bodyParser = require('koa-bodyparser');
const { KoaRouterSchema } = require('router-schema');
const schema = require('./schema');

const routerSchema = new KoaRouterSchema(new Router());
const app = new Koa();
const router = routerSchema.loadSchema(schema);

// handle the errors
app.use(async (ctx, next) => {
  try {
    await next();
  } catch (e) {
    ctx.body = e;
  }
});

app.use(bodyParser());
app.use(router.routes());
app.use((ctx) => {
  ctx.body = { hello: 'world' };
});

app.listen(8080);

Express.js

'use strict';

const express = require('express');
const bodyParser = require('body-parser');
const { ExpressRouterSchema } = require('router-schema');
const schema = require('./schema');

const app = express();

const routerSchema = new ExpressRouterSchema(express.Router());
const router = routerSchema.loadSchema(schema);

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));
app.use(router);

app.use((req, res) => res.json({ hello: 'world' }));

// handle errors
app.use((error, req, res, next) => res.json(error));

app.listen(8080);

API

RouterSchema.constructor(router, [options])

• router Router instance
• options an optional object with the following optional keys
  • joiOption joi config
  • handler request handler (...any) => ({data: {}, callback: (err,result) => {}})

const router = new Express.Router();
const routerSchema = new RouterSchema(router,{
  joiOption: {convert: false},
  handler: (req, res, next) => { //override default handler
    return {
      data: {body: req.body}, //data to be checked
      callback: (err, result) => { //check callback
        if(err) return next(err);
        next();
      }
    }
  }
})

RouterSchema.property.loadSchema(schema)

• schema request data schema

const schema = {
  'POST /foo/bar': { // [method + ]path
    query: { // request query schema
      foo: Joi.string()
    }
  },
  '/bar/foo': {
    body: { //request post data schema
      bar: Joi.number()
    }
  }
}

const routerSchema = new RouterSchema(new Express.Router());
const router = routerSchema.loadSchema(schema); 
// or 
//routerSchema.loadSchema(schema)
//const router = routerSchema.router;

ChangeLog

ChangeLog

License

MIT