在前端开发中，我们通常需要与后端API进行交互。在这个过程中，API返回的数据往往是JSON格式的。但是，有些API遵循的是 JSONAPI 规范，我们需要更专门的解析工具来处理这样的数据。
在本文中，我们将介绍一个npm包——jsonapi-deserializer，它可以帮助我们轻松地解析JSONAPI格式的数据。
什么是 JSONAPI
JSONAPI是一个规范，用于定义如何以一致的方式在不同的客户端和服务器之间交换数据。JSONAPI规范的主要目的是减少数据交换时的复杂度，并提供一致的数据结构，以方便客户端和服务器之间的数据交互。
JSONAPI规范的核心方法是在每个资源对象中定义一个 "type" 和 "id" 字段，以及一个包含关于该资源对象的元数据的 "attributes" 字段。此外，由于 JSONAPI 规范是基于 RESTful API 架构的，所以也包括诸如分页和过滤等常见的 RESTful API 功能。
jsonapi-deserializer简介
jsonapi-deserializer是一个小型的npm模块，用于将JSONAPI格式的数据解析成JavaScript对象。
使用jsonapi-deserializer，我们可以将从API获取的JSONAPI格式数据转换为易于在前端应用程序中使用的JavaScript对象。此外，jsonapi-deserializer还支持自定义格式化输出的功能。
安装
我们可以使用npm来安装jsonapi-deserializer：
npm install jsonapi-deserializer
使用
下面是一个展示如何使用jsonapi-deserializer的例子：
-- -------------------- ---- -------
------ ------------------- ---- -----------------------
-----------------
----- ---- - -
------- -
-
------- -----------
----- ----
------------- -
-------- ----- --- ------ -- ----------
-
--
-
------- -----------
----- ----
------------- -
-------- ------ -- --------
-
-
-
--
----- ------------ - --- ---------------------
---------------- -----------
---
----- ------ - -------------------------------
--------------------在上面的示例中，我们首先将 JSONAPI 格式的数据定义为一个常量。然后，我们从jsonapi-deserializer中导入一个JSONAPIDeserializer类，并在其中传递一个名为“keyForAttribute”的选项，该选项用于将每个属性名称从下划线格式转换为驼峰格式。
接下来，我们创建一个新的JSONAPIDeserializer实例，并使用其“deserialize”方法将JSONAPI格式的数据转换为JavaScript对象。最后，我们将转换后的数据输出到控制台。
自定义
jsonapi-deserializer支持自定义格式的输出。下面是一个示例，展示如何使用jsonapi-deserializer的自定义输出：
-- -------------------- ---- -------
------ ------------------- ---- -----------------------
-----------------
----- ---- - -
------- -
------- --------
----- ----
------------- -
------------ -------
----------- ------
-------- -----------------------
-------------- ----------
--
-------- -
------- ---------------------------------
-
-
--
----- ------------ - --- ---------------------
----------- -
------ ---------------
------------ -------
--
------ -
--------------------- -------- -------------- -
------ - --- ---------------- ----- ----------------- --
-
-
---
----- ------ - -------------------------------
--------------------在上面的代码示例中，我们定义了两个选项。第一个选项“attributes”用于将数据中的属性名称替换为我们希望使用的名称。在这个示例中，我们将“email”属性改名为“emailAddress”，将“phoneNumber”属性改名为“phone”。
第二个选项“users”用于自定义由数据中的“关系”所引用的任何嵌套资源的输出格式。在这个示例中，我们返回一个包含“关系”的ID和类型的对象。
最后，我们使用deserialize方法转换JSONAPI格式的数据，然后将转换的数据输出到控制台。
结论
通过使用jsonapi-deserializer，我们可以轻松地将从JSONAPI API获取的数据解析成可用JavaScript对象。该库提供了一些选项，可以轻松地自定义输出的格式。希望本文能够帮助您更好地理解JSONAPI规范和jsonapi-deserializer库，并在您的前端应用程序中受益。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005516f81e8991b448ceb1f