https://github.com/peakchen90/koa-params-validator

Koa2 请求参数校验
https://github.com/peakchen90/koa-params-validator

koa koa-middleware koa-validator koa2 object-validator request-validation

Last synced: about 1 month ago
JSON representation

Koa2 请求参数校验

• Host: GitHub
• URL: https://github.com/peakchen90/koa-params-validator
• Owner: peakchen90
• License: mit
• Created: 2018-08-26T09:41:00.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-05-12T09:15:27.000Z (over 5 years ago)
• Last Synced: 2024-10-04T04:30:55.358Z (about 1 month ago)
• Topics: koa, koa-middleware, koa-validator, koa2, object-validator, request-validation
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/koa-params-validator
• Size: 90.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# koa-params-validator

Koa2 请求参数校验中间件, 基于 [easy-object-validator](https://github.com/peakchen90/easy-object-validator) 校验

[![Build Status](https://travis-ci.org/peakchen90/koa-params-validator.svg?branch=master)](https://travis-ci.org/peakchen90/koa-params-validator)

[![Codecov](https://img.shields.io/codecov/c/github/peakchen90/koa-params-validator.svg)](https://codecov.io/gh/peakchen90/koa-params-validator)

[![npm](https://img.shields.io/npm/v/koa-params-validator.svg)](https://www.npmjs.com/package/koa-params-validator)

[![npm](https://img.shields.io/npm/dt/koa-params-validator.svg)](https://www.npmjs.com/package/koa-params-validator)

[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/peakchen90/koa-params-validator/blob/master/LICENSE)

## 安装

```bash

npm i -S koa-params-validator

```

## 环境要求

- Node >= 7.6

- Koa >= 2.0

## 快速开始

```js

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](https://github.com/peakchen90/easy-object-validator) 完全一致，请直接参考其用法

### **`validator`: Function(options, invalidMixinContext)**

  - {Object} `options` 校验规则，请参考 [easy-object-validator](https://github.com/peakchen90/easy-object-validator)

  - {Object} `invalidMixinContext` [可选] 未通过校验时将这个对象混合到Koa的context对象上，默认 status: 500, 默认 message: 'The parameter is invalid'

  - 返回一个Koa中间件