在现代 Web 开发中，API (Application Programming Interface) 到处都是。API 是应用程序之间进行数据交互的主要方式，RESTful API 是一种广泛应用的传统 API 模式，但随着前端框架的更新，GraphQL API 开始成为一种更加流行且强大的 API 模式。在本文中，我们将探讨如何将 RESTful API 转换为 GraphQL API 的经验总结。
RESTful API 与 GraphQL API 简介
RESTful API
RESTful API 是一种传统的 API 模式，通常使用 HTTP 协议进行通讯。RESTful API 从资源的角度来定义 API 接口。例如，我们可以通过以下方式来定义一个用户资源的 RESTful API：
GET /users 获取所有用户列表 GET /users/:id 获取指定用户 POST /users 创建新用户 PUT /users/:id 更新指定用户 DELETE /users/:id 删除指定用户
通过这种方式，我们可以通过 HTTP 请求来获取、创建、更新、删除指定资源。在 RESTful API 中，通常将请求方法与资源路径进行匹配，这样可以使 API 更加易于理解和使用。
GraphQL API
GraphQL API 是一种相对较新的 API 模型，它也使用 HTTP 通信并使用单个端点来处理所有请求。与 RESTful API 不同，GraphQL API 不是基于资源的，而是基于查询的。我们可以通过 GraphQL 类型系统来定义查询结构，从而表达客户端需要获取的数据。以下是一个查询用户信息的示例：
-- -------------------- ---- -------
----- -
-------- ---- -
----
-----
----- -
-----
-
-
-这个查询指定了我们要获取的用户 ID 为 1 的用户信息，以及该用户的所有文章标题。GraphQL API 会将查询 (Query) 转换为可执行的代码，并生成响应。此过程使得客户端可以精确地请求所需的数据，而无需传输不必要的数据。
将 RESTful API 转换为 GraphQL API
在实践中，我们通常需要将现有的 RESTful API 转换为 GraphQL API。在本节中，我们将讨论转换的过程。
分析 RESTful API
在转换 RESTful API 为 GraphQL API 之前，我们需要对 RESTful API 进行全面的分析，以了解资源和操作的完整列表。在这个过程中，我们可以记录以下信息：
- 所有资源和资源集合
- 支持的 HTTP 动词和状态码
- 嵌套关系和 API 自关联关系
设计 GraphQL Schema
在成功分析了 RESTful API 后，我们可以根据其资源和操作设计 GraphQL Schema。在这个过程中，我们可以考虑使用以下数据类型：
- Scalar types：例如 String、Int、Float 和 Boolean 等标量类型。
- Object types：自定义类型，可以表示 API 中的一类资源。
- Enumeration types：枚举类型，用于表示 API 定义的有限的取值集合。
- Input types：类似于 Object types，也可表示一个资源，但通常用于向 API 发送数据。
以下是一个用户信息查询的 GraphQL Schema 定义：
-- -------------------- ---- ------- ---- ---- - --- --- ----- ------- ------ ------- ------ -------- - ---- ---- - --- --- ------ ------- -------- ------- ------- ----- - ---- ----- - -------- ----- ---- --------- -------- -------- ----- ---- --------- -------- - ---- -------- - ----------------- ------------ ----- -------------- ---- ------ ------------ ----- -------------- ----- ----- - ----- --------- - ----- ------- ------ ------- -
在这个 Schema 中，我们定义了两种类型： User 和 Post ，它们分别对应 RESTful API 中的 users 和 posts 资源。我们还定义了两个 Query 方式： user 和 allUsers ，用于查询单个用户和所有用户。同样的，我们还设计了三个 Mutation 方式，用于创建、更新、删除用户。
实现 GraphQL Resolvers
Schema 定义的值本身没有任何数据，它需要结合具体的后端程序来响应 GraphQL 请求。这是我们需要编写 Schema 解析器的地方。解析器是将 GraphQL 查询转换为后端数据处理逻辑并返回结果的函数。
以下代码演示了使用 Node.js 中的 apollo-server-express 库来创建一个基本的 GraphQL Server。
-- -------------------- ---- -------
----- - ------------- --- - - ---------------------------------
----- ------- - -------------------
-- ---------
----- --------- - -
------ -
----- ------ - -- -- -------- ----- -- -
-- ---- -- ----- ---- -- -- ---- ------- ---
--
--------- ------ ----- -------- ----- -- -
-- ---- -- ----- --- ----- ---- ------- ---
--
----- ------ - -- -- -------- ----- -- -
-- ---- -- ----- ---- -- -- ---- ------- ---
--
--------- ------ ----- -------- ----- -- -
-- ---- -- ----- --- ----- ---- ------- ---
--
--
--------- -
----------- ------ - ----- -- -------- ----- -- -
-- ---- -- ------ --- ---- -- ------- ---
--
----------- ------ - --- ----- -- -------- ----- -- -
-- ---- -- ------ ---- -- -- -- ------- ---
--
----------- ------ - -- -- -------- ----- -- -
-- ---- -- ------ ---- -- -- -- ------- ---
--
--
----- -
------ ------ ----- -------- ----- -- -
-- ---- -- ----- --- ----- -- ---- ---- ------- ---
--
--
----- -
------- ------ ----- -------- ----- -- -
-- ---- -- ----- ------ -- ---- ---- ------- ---
--
--
--
-- ------
----- -------- - ----
---- ---- -
--- ---
----- -------
------ -------
------ --------
-
---- ---- -
--- ---
------ -------
-------- -------
------- -----
-
---- ----- -
-------- ----- ----
--------- --------
-------- ----- ----
--------- --------
-
---- -------- -
----------------- ------------ -----
-------------- ---- ------ ------------ -----
-------------- ----- -----
-
----- --------- -
----- -------
------ -------
-
--
-- ------
----- --- - ----------
----- ------ - --- --------------
---------
----------
---
------------------------ ---- ----- ---------- ---
------------ ----- ---- -- -- --
--------------- ------ ----- -- -------------------------------
--缓存 GraphQL 查询结果
GraphQL 查询通常是非常复杂的，它涉及到许多资源的获取和聚合。为了避免过多的性能问题，并且加速响应时间，通常需要使用缓存来缓存结果。GraphQL API 中的结果缓存与 RESTful API 的缓存非常相似，我们可以考虑使用 Redis, Memcached 或其他缓存服务来实现。
总结
在本文中，我们已经详细讨论了如何将现有的 RESTful API 转换为 GraphQL API。我们探讨了如何分析 RESTful API，如何设计 GraphQL Schema，以及如何使用实现 GraphQL Resolvers 和缓存查询结果。我们希望本文能够帮助你更好地理解和使用 GraphQL，并为你未来的 Web 开发提供指导和建议。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6590c5bfeb4cecbf2d609a0d