介绍
在前端开发中，经常需要用到 JSON 数据，有时候为了方便测试或者保留数据的可读性，我们会需要将 JSON 数据保存起来。这时候，npm 包 json-keeper 就可以派上用场了。
json-keeper 通过轻松地创建、公开和维护 JSON 文件，使得管理 JSON 数据变得相当简单、直观和可读性高。
本篇文章将讲解 json-keeper 的使用教程，主要包含以下几个部分：
- 安装
- 基本用法
- 高级用法
- 构建自己的 API 函数
- 总结
安装
npm 包 json-keeper 可以通过命令行的方式安装，输入以下命令即可：
npm install json-keeper --save
基本用法
json-keeper 通过一个 web 应用来提供一个 JSON 数据库 API。你可以将你的 JSON 文件推送到服务器，并获得一个公开 URL，来管理您的 JSON 数据库。以下是 json-keeper 的基本使用方法：
-- -------------------- ---- ------- ----- ---------- - ----------------------- -- ---- ---- ---------------- --------------------- ------ ----- ---- ----- ------------- -- - ------------------ --------- ---------------------- -- ----------- ---- --- --------------------------------------------------------------- -- - ------------------ ----------------------
通过调用 JsonKeeper.pushJson() 函数可以将一个 JSON 对象推送到服务器，并获取一个公开的地址来管理 JSON 数据库。而 JsonKeeper.getJson() 函数则可以使用公开的地址获取 JSON 数据库。
高级用法
除了基本的用法，json-keeper 还有一些高级用法，可以为你的前端开发提供更多的便利。
内存模式
除了使用服务器模式，你还可以使用内存模式来保存你的 JSON 数据。这种模式相当于在前端代码中，使用 JavaScript 对象来保存 JSON 数据。以下是一个使用内存模式的实例：
const JsonKeeper = require('json-keeper');
// 在内存中创建 JSON 数据库，并获取一个唯一 ID
const id = JsonKeeper.createInMemoryDb({ userName: 'harry', age: 18 });
// 获取 ID 对应的 JSON 对象
const obj = JsonKeeper.getInMemoryDb(id);
console.log(obj); // { userName: 'harry', age: 18 }使用 JsonKeeper.createInMemoryDb() 函数可以创建一个唯一的 ID，并将一个 JSON 对象保存在内存中。使用 JsonKeeper.getInMemoryDb() 函数可以通过 ID 获取对应的 JSON 对象。
认证
对于需要保密的数据，json-keeper 可以让你在分享 JSON 数据库时添加一个令牌。一旦令牌被添加到请求的 URL 中，json-keeper 会密切审核该请求，以确认该请求是否批准。以下是一个使用认证功能的实例：
-- -------------------- ---- ------- ----- ---------- - ----------------------- -- ------ ---- ---------- ----------------------------- ----- -------- ---- -- -- - --------- ------- --------- ----- ------------- -- - ------------------ --------- ---------------------- -- --- ---- ---------- ----- ----- - --------------------------------------- -------------------------------------------------------------------------------------- -- - ------------------ ----------------------
使用 JsonKeeper.pushJsonWithAuth() 函数可以使用密码保护 JSON 数据库，生成认证令牌。使用 JsonKeeper.getJsonWithAuth() 函数可以在获取 JSON 数据库时添加认证令牌。
构建自己的 API 函数
除了使用 json-keeper 已有的函数外，你可以通过继承 JsonKeeper 类并重载方法的方式，构建自己的 API 函数。以下是一个简单的自定义 API 函数的实例：
-- -------------------- ---- -------
----- - ---------- - - -----------------------
----- ------------ ------- ---------- -
------------- -
--------
-
------ ----- ---------------- -
------ ---------------- ----- -------------------- -- --------------
-
------ ----- ----------- -
------ ----------------------------
-
-
------------------------- ----- -------- ---- -- -------------- -- -
------------------
----------------------
------------------------------------ -- -
------------------
----------------------使用继承并重载 JsonKeeper 类的方法即可构建自己的 API 函数。
总结
通过本篇文章，我们了解了如何安装和使用 json-keeper 包，并介绍了 json-keeper 包的基本用法、高级用法和如何构建自己的 API 函数。希望这篇文章可以帮助你在前端开发中更方便地管理 JSON 数据库。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056c7581e8991b448e5f3b