在前端开发中，我们经常需要模拟后端接口返回数据，前端 mock 是一个不错的方式。但是，手动编写 mock 数据相对比较麻烦和复杂，今天我们来介绍一个 npm 包 mock-json-schema，它能够快速方便地生成符合 JSON Schema 标准的 mock 数据，大家可以轻松上手使用。
JSON Schema 是什么？
JSON Schema 是一个用于验证 JSON 对象的结构和约束的语言。它提供了一个类似于 XML Schema、RELAX NG 等的应用程序接口，可实现数据交换的语法约束
mock-json-schema 使用说明
- 安装
npm i mock-json-schema --save-dev
- 引入
const MockSchema = require('mock-json-schema')
- 编写 schema
MockSchema 根据 JSON Schema 标准来生成 mock 数据，首先我们需要编写一个符合 JSON Schema 标准的 schema。下面是一个例子：
-- -------------------- ---- ------- - ---------- ------------------------------------------ -------- ---------- -------------- -- ------- ---- ------ --------- ------- --------- ------------- - ----- - ------- ---------- ---------- -- ---------- ---- -- ------- - ------- --------- -------- --------------- -- -------- - ------- --------- ---------- -- ------------------- --- -- ------- - ------- -------- -------- - ------- --------- ------- - ------- ---------- -------------- ------------- - -- ----------- -- ----------- -- -------------- ---- -- -------- - ------- --------- ------------- - ----------- - ------- ---------- ---------- -- ---------- ---- -- ----------- - ------- --------- -------- -------------- - -- ----------- - ----------- ---------- - - -- ----------- - ----- ------- -------- ------- ------- - -展开代码
这个 schema 描述了一个产品对象，它有 id、name、price、tags、stock 等属性。其中，name 属性使用了 faker 函数库中的 findName 方法来生成随机名称。tags 属性是一个字符串数组，元素只能包含 food、clothes、electronics 和 accessories 中的一个，且元素不能重复。
- 生成 mock 数据
const schema = require('./schema') const Mock = new MockSchema() const data = Mock.mock(schema) console.log(data)
上面代码中，我们使用 MockSchema 类的 mock 方法，传入编写好的 schema，在 console 中打印生成的 mock 数据。
代码示例
下面是完整的代码示例：
const MockSchema = require('mock-json-schema') const schema = require('./schema') const Mock = new MockSchema() const data = Mock.mock(schema) console.log(data)
schema.json
-- -------------------- ---- ------- - ---------- ------------------------------------------ -------- ---------- -------------- -- ------- ---- ------ --------- ------- --------- ------------- - ----- - ------- ---------- ---------- -- ---------- ---- -- ------- - ------- --------- -------- --------------- -- -------- - ------- --------- ---------- -- ------------------- --- -- ------- - ------- -------- -------- - ------- --------- ------- - ------- ---------- -------------- ------------- - -- ----------- -- ----------- -- -------------- ---- -- -------- - ------- --------- ------------- - ----------- - ------- ---------- ---------- -- ---------- ---- -- ----------- - ------- --------- -------- -------------- - -- ----------- - ----------- ---------- - - -- ----------- - ----- ------- -------- ------- ------- - -展开代码
输出结果：
-- -------------------- ---- ------- - ----- ---- ------- -------- ----------- -------- ------------------ ------- - -------------- -------------- ------ -- -------- - ----------- --- ----------- ----- ------ - -展开代码
总结
mock-json-schema 是一个实用的 npm 包，使用简单，能够快速方便地生成符合 JSON Schema 标准的 mock 数据。在开发过程中使用 mock-json-schema，可以大大简化我们的工作。希望本文的介绍能够对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f32baa5dbf7be33b2566dc1
