Tiny module to generate request validation middleware for Koa using Joi.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Setup project Aug 22, 2017
LICENSE Initial commit Aug 22, 2017
README.md Update readme and rename validate function Sep 1, 2017
index.js Update readme and rename validate function Sep 1, 2017
package-lock.json Setup project Aug 22, 2017
package.json Update readme and rename validate function Sep 1, 2017

README.md

Koa-Joi-Validate

A tiny module to provide Joi validation middleware within a Koa server.

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

Install

npm install koa-joi-validate

Import

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

or

import validate from 'koa-joi-validate'

Usage

To use the module, call validate with an object containing Joi validation objects 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-validate')

const app = new Koa()

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

app.use(async ctx => {
  ctx.body = 'Hello World';
});


app.listen(5000)

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

const router = new Router()

const loginValidator = validate({
  body: {
    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.