OpenAPI Model

Create easy a Model from a OpenAPI spec.

Installation

npm install @hckrnews/openapi-model or yarn add @hckrnews/openapi-model

Test the package

npm run test or yarn test

How to use

1const schema = {
2    type: 'object',
3    properties: {
4        foo: {
5            type: 'string',
6            default: 'bar'
7        }
8    },
9    required: ['foo'],
10    additionalProperties: false
11}
12
13const options = {
14    validate: true,
15    strict: false,
16    extraAjvFormats: ['date-time']
17}
18
19const ExampleModel = openapiToModel(schema, options)
20
21// Create an empty model, with the default values
22const example = new ExampleModel()
23/*
24{
25    foo: 'bar'
26}
27*/
28
29// Create a model with the default values, but overwrite the given properties
30const example2 = new ExampleModel({
31    foo: 'It works!'
32})
33/*
34{
35    foo: 'It works!'
36}
37*/
38
39// Create a model with the default values, but overwrite the given properties
40const example2 = new ExampleModel({
41    foo: 3.14
42})
43/*
44    Throws an Error because the type is wrong
45
46    error.message
47    "Invalid data"
48
49    error.errors
50    [
51      {
52        instancePath: '/foo',
53        keyword: 'type',
54        message: 'must be string',
55        params: {
56          type: 'string'
57        },
58        schemaPath: '#/properties/foo/type'
59      }
60    ]
61
62    error.schema
63    {
64        type: 'object',
65        properties: {
66            foo: {
67                type: 'string',
68                default: 'bar'
69            }
70        },
71        required: ['foo'],
72        additionalProperties: false
73    }
74
75    // The object that is send to the model
76    error.data
77    {
78        foo: 3.14
79    }
80
81    // The object that is send to the model, but also with the default values
82    error.newData
83    {
84        foo: 3.14
85    }
86*/