Code Monkey home page Code Monkey logo

koa-params-validator's Introduction

koa-params-validator

Koa2 请求参数校验中间件, 基于 easy-object-validator 校验

Build Status Codecov npm npm GitHub

安装

npm i -S koa-params-validator

环境要求

  • Node >= 7.6
  • Koa >= 2.0

快速开始

const validator = require('koa-params-validator')
const app = new require('koa')();

// validator() 返回一个Koa2中间件方法,未通过校验的将返回 500 状态码
app.use(validator({
  query: {
    keyword: validator.string().isRequire()
  },
  body: {
    data: validator.arrayOf(validator.object())
  }
}))

// 在路由中使用
route.post('/login', validator({
  body: {
    username: validator.string().isRequire()
    password: validator.string().isRequire()
  }
}, {
  statsu: 200,
  state:{
    success: false,
    data: '用户名或密码不能为空'
  }
}), (ctx) => {
  // login...
})

API

校验规则的API与 easy-object-validator 完全一致,请直接参考其用法

validator: Function(options, invalidMixinContext)

  • {Object} options 校验规则,请参考 easy-object-validator
  • {Object} invalidMixinContext [可选] 未通过校验时将这个对象混合到Koa的context对象上,默认 status: 500, 默认 message: 'The parameter is invalid'
  • 返回一个Koa中间件

koa-params-validator's People

Contributors

peakchen90 avatar

Stargazers

 avatar

Watchers

 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.