try-to-learn/koa-joi-validator-mw

A npm module to generate request validation middleware for Koa using Joi.

koa-joi-validator-mw

A npm module to generate request validation middleware for Koa using Joi.

Using the module allows you to easily generate Koa middleware to validate incoming requests using Joi.

Install

npm install koa-joi-validator-mw

Import

const validate = require('koa-joi-validator-mw')

or

import validate from 'koa-joi-validator-mw'

Usage

To use the module, call validate with an object containing Joi validation schemas for the request headers, URL query, URL path params, and post body.

The following basic example will verify that any request to the server contains a properly formatted request ID header and user ID url query parameter.

const Koa = require('koa')
const joi = require('joi')
const validate = require('koa-joi-validator-mw')

const app = new Koa()

app.use(validate({
  headers: joi.object({
    // Request headers Joi validation object
    "x-request-id": joi.string().alphanum().length(32)
  }).options({
     stripUnknown: true
  }),
  query: joi.object({
    // URL query string Joi validation object
    userid: joi.string().required()
  }),
  params: joi.object({
    // URL path parameters Joi validation object
  }),
  body: joi.object({
    // POST body Joi validation object
  })
}))

app.use(async ctx => {
  ctx.body = 'Thank you for using koa-joi-validator-mw';
});


app.listen(8000)

Here is another basic example, mounting a validator on a specific route using koa-router.

const router = new Router()

const loginValidator = validate({
  body: joi.object({
    username: Joi.string().required(),
    password: Joi.string().required()
  })
})

router.post('/login', loginValidator, async ctx => {
  const { username, password } = ctx.body
  const response = await login(username, password)
  ctx.body = response
})

For more examples of the (very powerful) validation capabilities of Joi, view the official documentation - https://github.com/hapijs/joi

If the validation fails, an HTTP 400 response will be returned to the client, along with a short human-readable error message explaining why the request was rejected. You can handle the validation errors by registering errorCallback function

const validator = validate(schema, errorCallback);

function errorCallback(ctx, error) {
}