https://github.com/zweifisch/kontur
a little DSL that outputs JSON schema
https://github.com/zweifisch/kontur
Last synced: 4 months ago
JSON representation
a little DSL that outputs JSON schema
- Host: GitHub
- URL: https://github.com/zweifisch/kontur
- Owner: zweifisch
- License: mit
- Created: 2016-12-13T13:30:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-16T23:42:15.000Z (over 8 years ago)
- Last Synced: 2024-10-11T00:05:34.115Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 31.3 KB
- Stars: 78
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kontur
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Node.js Version][node-version-image]][node-version-url]
a little DSL that outputs JSON schema
[instruction](koa.md) on validating request body in koa using ajv and kontur
## overview
```js
import { compile, bool, int, str } from 'kontur'
compile({
gender: str,
age: int,
nickname: str,
verified: bool
})
```
will generate
```js
{
type: 'object',
properties: {
gender: { type: 'string' },
age: { type: 'integer' },
nickname: { type: 'string' },
verified: { type: 'boolean' }
},
required: [ 'gender', 'age', 'nickname', 'verified' ]
}
```
```js
compile({
gender: str.in('male', 'female').optional,
age: int.between(0, 200),
nickname: str.minlen(3).match(/^[a-zA-Z]/),
verified: bool.optional.default(false)
})
```
will generate
```js
{
type: 'object',
properties: {
gender: {
enum: ['male', 'female'],
type: 'string'
},
age: {
minimum: 0,
maximum: 200,
type: 'integer'
},
nickname: {
minLength: 3,
pattern: '^[a-zA-Z]',
type: 'string'
},
verified: {
default: false,
type: 'boolean'
}
},
required: [ 'age', 'nickname' ]
}
```
nested schema
```js
compile({
assignment: {
assignees: array.len(3).uniq.items(str.len(16)),
assigner: object.strict.properties({
id: str.len(16)
}),
assigned_at: str.datetime
}
})
```
the output can be found [here](lib/compile.test.js)
## types
### object
`strict`, no extra properties should be included
`size(num)`, `maxsize(num)`, `minsize(num)`, limit the number of properties
`properties(schema)`, specify schema of children
### array
`strict`, no extra items should be included
`len(num)`, `minlen(num)`, `maxlen(num)`, limit the length of the array
`items(schema)`, all element should match
`uniq`
`contains(schema)`, at least one element should match
### string
`match(regexp)`, match a regular expression
`email`, `ipv4`, `ipv6`, `uri`, `datetime`, built-in formats
### number/int
`min(num)`, `max(num)`, `between(num, num)`,
`min(num).exclusive`, `max(num).exclusive`
### null
`nil` just null
### boolean
`bool`
### tuple(direived from array)
use plain array
```
[str, int.between(1,5)]
```
### enum
```
str.in('created', 'suspended', 'deleted')
```
```
any('male', 'female')
```
## miscs
`optional` used in context of object, by default all keys are required
`depends(keys)` used in context of object
`default(value)` add default value
`desc(text)` add description
`title(text)` add title
## combining schemas
### all
```
all(int.min(0), int.max(1))
```
### any
```
any(int.min(1).exclusive, int.max(0).exclusive)
```
### one
```
one(int.min(0), int.max(1))
```
### not
```
not.nil
```
```
not.object.array
```
[npm-image]: https://img.shields.io/npm/v/kontur.svg?style=flat
[npm-url]: https://npmjs.org/package/kontur
[travis-image]: https://img.shields.io/travis/zweifisch/kontur.svg?style=flat
[travis-url]: https://travis-ci.org/zweifisch/kontur
[node-version-image]: https://img.shields.io/node/v/kontur.svg
[node-version-url]: https://nodejs.org/en/download/