Giter Club home page Giter Club logo

koa-json-schema's Introduction

koa-json-schema

CircleCI

json schema validation middleware for koajs using AJV.

install

npm install --save koa-json-schema

usage

validate input as

const input = Object.assign({},
{ query: ctx.request.query || {} },
{ body: ctx.request.body || {} },
{ params: ctx.params || {} });
const koa=require('koa')
const {middleware: validator} = require('koa-json-schema')

koa()
    .use(validator(schema, options))
    .use(function (ctx){
       // do something with safe input
    });
  • schema: a valid json schema
  • options: options to pass to AJV

if the input is not valid 422 error is thrown. the validation errors can be found as error.error_description

koa()
    .use(async function (ctx, next){
        try {
            await next();
        } catch(e){
           if(e.status === 422){
                console.log(e.error_description);
           }
        }
    })
    .use(validator(schema, options))
    .use(function (ctx){
       // do something with safe input
    });

koa-json-schema's People

Contributors

lorenzofox3 avatar laurenthayez avatar mistertoucan avatar timwis avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.