Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nswbmw/koa-scheme
koa-scheme is a parameter validation middleware for koa.
https://github.com/nswbmw/koa-scheme
Last synced: about 2 months ago
JSON representation
koa-scheme is a parameter validation middleware for koa.
- Host: GitHub
- URL: https://github.com/nswbmw/koa-scheme
- Owner: nswbmw
- Created: 2014-07-18T08:00:07.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2021-08-13T03:48:30.000Z (about 3 years ago)
- Last Synced: 2024-07-08T14:07:51.811Z (2 months ago)
- Language: JavaScript
- Size: 105 KB
- Stars: 46
- Watchers: 9
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-github-star - koa-scheme - scheme is a parameter validation middleware for koa. | nswbmw | 48 | (JavaScript)
README
## koa-scheme
koa-scheme is a parameter validation middleware for koa.
version v3.0.0 support for koa2
### Install
npm i koa-scheme --save
### Usage
scheme(config, options)
- config: {Object|String} scheme object or path.
- options: {Object}
- debug: {Boolean} If true, print compiled `config` and throw error, Default false.
**app.js**
```
var koa = require('koa');
//var bodyParser = require('koa-bodyparser');
var scheme = require('koa-scheme');
var conf = require('./scheme');
var route = require('./route');
var app = koa();
//app.use(bodyParser());
app.use(scheme(conf));
route(app);
app.listen(3000, function() {
console.log("listening on 3000")
});
```
**scheme.json**
```
{
"/(.*)": {
"request": {
"header": {
"version": "[1-9]+"
}
}
},
"/": {
"response": {
"status": 200
}
},
"GET /user/:username": {
"response": {
"body": {
"name": /[a-z]+/i,
"age": "[0-9]{1,3}"
}
}
},
"/user/:username": {
"request": {
"method": "(POST|patch)",
"body": {
"name": "[a-zA-Z]+",
"age": /[0-9]{1,3}/
}
},
"response": {
"status": 200
}
},
"(delete|OPTIONS) /user/:username": {
...
}
}
```
see [path-to-regexp](https://github.com/pillarjs/path-to-regexp).
**NB**: when use body-parser middleware (like: koa-bodyparser) before koa-scheme, you could configure 'body' field in 'request'.
use function:
**scheme.js**
```
module.exports = {
"/users": {
"request": {
"method": "POST",
"body": {
"nameArr": testRequestNameArr
}
}
}
}
function testRequestNameArr(arr) {
if (arr.length === 3 && arr[1] === 'nswbmw') {
return true;
} else {
return false;
}
}
```
with [validator](https://github.com/chriso/validator.js):
**scheme.js**
```
var validator = require('validator');
module.exports = {
"GET /user/:username": {
"response": {
"body": {
"age": validator.isNumeric,
"email": validator.isEmail,
"webset": validator.isURL,
...
}
}
}
}
```
Even you could write flat object like this:
```
{
"GET /user/:username": {
"response": {
"body.age": validator.isNumeric,
"body.email": validator.isEmail,
"body.family.mother.age": validator.isNumeric
}
}
}
```
### Example
**scheme.js**
```
var validator = require('validator');
module.exports = {
"/(.*)": {
"request": {
"header.version": "[1-9]+"
}
},
"/users": {
"request": {
"method": "GET"
},
"response": {
"body": testRes
}
},
"GET /user/:username": {
"response": {
"body": {
"name": "[a-zA-Z]+",
"age": validator.isNumeric,
"email": validator.isEmail
}
}
},
"/user/:username": {
"request": {
"method": "(POST|PATCH)",
"body.name": /[a-zA-Z]+/,
"body.age": "[0-9]{1,3}",
"body.email": validator.isEmail
}
},
"(delete|OPTIONS) /user/:username": {
"response": {
"status": 200
}
}
}
// throw a error is ok
function testRes(arr) {
throw new Error('badRequest');
}
```
### Test
npm test
### License
MIT