https://github.com/alt3/sequelize-to-json-schemas
Convert Sequelize models into various JSON Schema variants (using the Strategy Pattern)
https://github.com/alt3/sequelize-to-json-schemas
javascript json-schema oas oas2 openapi sequelize strategy-pattern swagger
Last synced: 19 days ago
JSON representation
Convert Sequelize models into various JSON Schema variants (using the Strategy Pattern)
- Host: GitHub
- URL: https://github.com/alt3/sequelize-to-json-schemas
- Owner: alt3
- License: mit
- Created: 2019-08-03T09:29:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-18T17:30:51.000Z (over 3 years ago)
- Last Synced: 2025-03-25T18:16:32.164Z (about 1 month ago)
- Topics: javascript, json-schema, oas, oas2, openapi, sequelize, strategy-pattern, swagger
- Language: JavaScript
- Homepage:
- Size: 344 KB
- Stars: 35
- Watchers: 3
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE.txt
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@alt3/sequelize-to-json-schemas)
[](https://app.travis-ci.com/alt3/sequelize-to-json-schemas)
[](https://snyk.io/test/github/alt3/sequelize-to-json-schemas)
[](https://codecov.io/gh/alt3/sequelize-to-json-schemas)
[](https://codeclimate.com/github/alt3/sequelize-to-json-schemas)
[](https://conventionalcommits.org)
[](https://www.contributor-covenant.org/version/2/0/code_of_conduct)
# sequelize-to-json-schemas
Convert Sequelize models into these JSON Schema variants (using the Strategy Pattern):
- JSON Schema Draft-07 - [sample output](examples/json-schema-v7.md)
- OpenAPI 3.0 - [sample output](examples/openapi-v3.md)
Compatible with Sequelize versions 4, 5 and 6.
## Main Goals
- understandable code, highly maintainable
- valid schemas (enforced by the [ajv](https://github.com/epoberezkin/ajv) and [Swagger Parser](https://github.com/APIDevTools/swagger-parser) validators)
- JsonSchemaManager for single (rock solid) core functionality shared between all strategies
- StrategyInterface for simplified implementation of new schema variants
> Feel free to PR strategies for missing schemas
## Installation
```bash
npm install @alt3/sequelize-to-json-schemas --save
```
## Usage
```javascript
const { JsonSchemaManager, JsonSchema7Strategy, OpenApi3Strategy } = require('@alt3/sequelize-to-json-schemas');
const schemaManager = new JsonSchemaManager();
// now generate a JSON Schema Draft-07 model schema
let schema = schemaManager.generate(userModel, new JsonSchema7Strategy());
// and/or the OpenAPI 3.0 equivalent
schema = schemaManager.generate(userModel, new OpenApi3Strategy());
```
## Configuration Options
To configure global options use the JsonSchemaManager initialization:
```javascript
const schemaManager = new JsonSchemaManager({
baseUri: '/',
absolutePaths: true,
secureSchemaUri: true,
disableComments: true,
});
```
To configure (per) model options use the `generate()` method:
```javascript
const userSchema = schemaManager.generate(userModel, strategy, {
title: 'Custom model title',
description: 'Custom model description',
exclude: ['someAttribute'],
include: ['someAttribute'],
associations: true,
excludeAssociations: ['someAssociation'],
includeAssociations: ['someAssociation'],
});
```
The following Sequelize attribute options are automatically converted into
schema properties:
```javascript
module.exports = (sequelize) => {
const model = sequelize.define('user', {
userName: {
type: DataTypes.STRING,
allowNull: true,
defaultValue: 'Default Value',
associate: {},
},
});
return model;
};
```
To configure additional schema properties add a `jsonSchema` property with
one or more of the following custom options to your Sequelize attribute:
```javascript
module.exports = (sequelize) => {
const model = sequelize.define('user', {
userName: {
type: DataTypes.STRING,
jsonSchema: {
description: 'Custom attribute description',
comment: 'Custom attribute comment',
examples: ['Custom example 1', 'Custom example 2'],
readOnly: true, // OR writeOnly: true
},
},
});
return model;
};
```
In order to create a valid output for `JSON` columns, or to otherwise override
the schema output for a particular sequelize attribute, add a `schema` attribute:
```javascript
module.exports = (sequelize) => {
const model = sequelize.define('user', {
// ...
settings: {
type: DataTypes.JSON,
jsonSchema: {
schema: { type: 'object' },
},
},
});
return model;
};
```
## Framework Integrations
## License
This project is released under [MIT LICENSE](LICENSE.txt).
## Contributing
Please refer to the [guidelines for contributing](./contributing.md).
