ajv-openapi

Ajv plugin that adds Open API v3 data types (formats: int32, int64, float, double, byte) validation.

Installation

1npm install ajv ajv-openapi

Usage

1const Ajv = require("ajv");
2const openApi = require("ajv-openapi");
3
4const ajv = openApi(new Ajv());

Configuration for full OpenAPI compatibility

By default, the plugin only adds missing formats to Ajv validator. To configure Ajv to be fully Open API v3 compliant, you should configure the plugin like this:

1const Ajv = require("ajv");
2const openApi = require("ajv-openapi");
3
4const ajvOptions = {
5    schemaId: "auto",
6    format: "full",
7    coerceTypes: true,
8    unknownFormats: "ignore",
9    useDefaults: true,
10    nullable: true
11};
12
13const openApiOptions = {
14    useDraft04: true
15};
16
17const ajv = openApi(
18    new Ajv(ajvOptions),
19    openApiOptions
20);

Examples

1console.log(ajv.compile({ type: "integer", format: "int32" })(2147483648));
2console.log(ajv.compile({ type: "integer", format: "int32" })(-2147483649));
3console.log(ajv.compile({ type: "integer", format: "int32" })(1.23));
4console.log(ajv.compile({ type: "integer", format: "int32" })(123));
5> false
6> false
7> false
8> true
9
10console.log(ajv.compile({ type: "integer", format: "int64" })(Number.MAX_VALUE));
11console.log(ajv.compile({ type: "integer", format: "int64" })(Number.MIN_VALUE));
12console.log(ajv.compile({ type: "integer", format: "int64" })(1.23));
13console.log(ajv.compile({ type: "integer", format: "int64" })(123));
14> false
15> false
16> false
17> true
18
19console.log(ajv.compile({ type: "number", format: "float" })(Number.MAX_VALUE));
20console.log(ajv.compile({ type: "number", format: "float" })(Number.MIN_VALUE));
21console.log(ajv.compile({ type: "number", format: "float" })(1.23));
22console.log(ajv.compile({ type: "number", format: "float" })(123));
23> false
24> false
25> true
26> true
27
28console.log(ajv.compile({ type: "number", format: "double" })(Number.MAX_VALUE));
29console.log(ajv.compile({ type: "number", format: "double" })(Number.MIN_VALUE));
30console.log(ajv.compile({ type: "number", format: "double" })(1.23));
31console.log(ajv.compile({ type: "number", format: "double" })(123));
32> true
33> true
34> true
35> true
36
37console.log(ajv.compile({ type: "string", format: "byte" })("MTIz"));
38console.log(ajv.compile({ type: "string", format: "byte" })("abc"));
39console.log(ajv.compile({ type: "string", format: "byte" })(1));
40console.log(ajv.compile({ type: "string", format: "byte" })("5L2g5aW95ZWK"));
41> true
42> false
43> false
44> true