https://github.com/dantman/koa-request-schema

Data validation using jsonschema for koa
https://github.com/dantman/koa-request-schema

Last synced: about 1 month ago
JSON representation

Data validation using jsonschema for koa

• Host: GitHub
• URL: https://github.com/dantman/koa-request-schema
• Owner: dantman
• Created: 2016-05-16T17:21:20.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-05-17T19:04:19.000Z (over 8 years ago)
• Last Synced: 2024-11-14T16:36:19.760Z (about 2 months ago)
• Language: JavaScript
• Size: 167 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • Changelog: history.md

Awesome Lists containing this project

README

        
koa-request-schema

=============

[![NPM version][npm-image]][npm-url]

[![build status][travis-image]][travis-url]

[![David deps][david-image]][david-url]

[![node version][node-image]][node-url]

[![io version][io-image]][node-url]

[npm-image]: https://img.shields.io/npm/v/koa-request-schema.svg?style=flat-square

[npm-url]: https://npmjs.org/package/koa-request-schema

[travis-image]: https://img.shields.io/travis/dantman/koa-request-schema.svg?style=flat-square

[travis-url]: https://travis-ci.org/dantman/koa-request-schema

[david-image]: https://img.shields.io/david/dantman/koa-request-schema.svg?style=flat-square

[david-url]: https://david-dm.org/dantman/koa-request-schema

[node-image]: https://img.shields.io/badge/node.js-%3E=_0.11.9-green.svg?style=flat-square

[node-url]: http://nodejs.org

[io-image]: https://img.shields.io/badge/io.js-%3E=_1.0-yellow.svg?style=flat-square

[io-url]: https://iojs.org

`koa-request-schema` implements request data validation using jsonschema. If data does not pass validation, the server returns a `400 Bad Request` error. In non production environments, the response body is populated with the validation errors.

Usage

-----

```js

const schema = require('koa-request-schema');

router.post('/secret/:object',

	schema({

		params: {

			properties: {

				object: { type: 'string', required: true }

			}

		},

		query: {

			properties: {

				something: { type: 'string', required: false } }

			}

		},

		body: {

			properties: {

				password: { type: 'string', required: true, minLength: 10 }

			}

		}

	}),

	function *() {

		let body = this.request.body;

		if (body.password === 'the best password ever') {

			this.body = 'You got it boss';

		} else {

			this.throw(403, 'Pffttt...');

		}

	});

```

The error includes the following properties on schema validation error. The `validationErrors` property is the `errors` property returned by `jsonschema` on validation.

```json

{

	"message": "Invalid request parameters",

	"details": {

		"validationErrors": [{

			"property": "request.body",

			"message": "Property password is required",

			"schema": { ... },

			"instance": ...

		}]

	}

}

```

Options

-------

Options may be passed as the second argument to `koa-request-schema`; additionally `require('koa-request-schema').create({ ... })` will return a function with options you pass it as defaults.

* `displayErrors` [default=`true` in non-production environments]: Include validationErrors in the error.

* `coerceTypes` [default=`true`]: Convert string values for date, integer, number, boolean, and object types to their respective type.

* `validator`: Override the jsonschema Validator instance used.

* `strict` [default=`true`]: Do not permit unknown properties in params, query, or body unless the schema defines its own `additionalProperties` value. (Default cannot be changed)

Koa 2 Support

-------------

To use `koa-request-schema` with `koa@2`, please use:

```sh

npm install --save koa-request-schema@next

```

[Changelog](./history.md)

-------------------------