JSON Schema是描述JSON数据结构的语言标准，其规定了一个JSON Schema的表示方法，帮助我们表达JSON数据结构的限制和规则。json-schema-helpers是一款用于生成JSON Schema的npm包，它可以快速地帮助我们生成JSON Schema对象，并在操作时提供了一定的指导意义，下面我们来详细了解一下json-schema-helpers。
安装
我们可以通过npm安装json-schema-helpers包：
$ npm install json-schema-helpers
示例
下面的示例创建了一个基本对象JSON Schema：
const Schema = require('json-schema-helpers').Schema;
const schema = new Schema();
schema.setType('object');
schema.addProperty('name', {type: 'string', minLength: 1});
schema.addProperty('age', {type: 'number', minimum: 18});
console.log(JSON.stringify(schema.getSchema()));输出结果：
-- -------------------- ---- -------
-
------- ---------
------------- -
------- -
------- ---------
------------ -
--
------ -
------- ---------
---------- --
-
-
-操作
setType
我们可以使用setType方法来设置JSON Schema对象的类型，可选值包括：
- object：表示一个对象
- array：表示一个数组
- integer：表示一个整数
- number：表示一个数字
- string：表示一个字符串
- boolean：表示一个布尔值
- null：表示一个空值
const Schema = require('json-schema-helpers').Schema;
const schema = new Schema();
schema.setType('string');
console.log(JSON.stringify(schema.getSchema()));输出结果：
{
"type": "string"
}addProperty
我们可以使用addProperty方法添加一个属性到JSON Schema对象中，参数包括属性名称和属性值，属性值为一个JSON Schema对象。
const Schema = require('json-schema-helpers').Schema;
const schema = new Schema();
schema.setType('object');
schema.addProperty('name', {type: 'string', minLength: 1});
schema.addProperty('age', {type: 'number', minimum: 18});
console.log(JSON.stringify(schema.getSchema()));输出结果：
-- -------------------- ---- -------
-
------- ---------
------------- -
------- -
------- ---------
------------ -
--
------ -
------- ---------
---------- --
-
-
-addRequired
我们可以使用addRequired方法设置必需属性，参数为一个字符串数组，数组中包含了必需属性的名称。
-- -------------------- ---- ------- ----- ------ - -------------------------------------- ----- ------ - --- --------- ------------------------- -------------------------- ------ --------- ---------- ---- ------------------------- ------ --------- -------- ----- ----------------------------- ------------------------------------------------
输出结果：
-- -------------------- ---- -------
-
------- ---------
------------- -
------- -
------- ---------
------------ -
--
------ -
------- ---------
---------- --
-
--
----------- -
------
-
-addItems
我们可以使用addItems方法添加一个元素到JSON Schema对象中，参数为一个JSON Schema对象。
const Schema = require('json-schema-helpers').Schema;
const schema = new Schema();
schema.setType('array');
schema.addItems({type: 'string', minLength: 1});
console.log(JSON.stringify(schema.getSchema()));输出结果：
{
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}addProperties
我们可以使用addProperties方法添加多个属性到JSON Schema对象中，参数为一个对象，对象中的键为属性名称，值为JSON Schema对象。
-- -------------------- ---- ------- ----- ------ - -------------------------------------- ----- ------ - --- --------- ------------------------- ---------------------- ----- ------ --------- ---------- --- ---- ------ --------- -------- --- --- ------------------------------------------------
输出结果：
-- -------------------- ---- -------
-
------- ---------
------------- -
------- -
------- ---------
------------ -
--
------ -
------- ---------
---------- --
-
-
-总结
json-schema-helpers是一款非常方便的npm包，可以帮助我们快速生成JSON Schema对象，而且使用起来非常简单。我们可以根据自己的需求使用不同的方法来操作JSON Schema对象，json-schema-helpers会提供一定的指导意义，让我们更加容易地完成操作。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600551f681e8991b448cf7a1