GraphQL 的类型系统:解决你的 API 参数问题

GraphQL 是一种由 Facebook 开发的 API 查询语言,它提供了一种更高效、更灵活的方式来定义和查询 API。其中最重要的特性之一就是它的类型系统。

在传统的 REST API 中,我们通常需要手动解析请求参数和响应数据,这通常需要大量的代码和文档来确保开发人员和客户端了解 API 的正确使用方式。而 GraphQL 的类型系统可以让我们在定义 API 时就明确参数和返回值的类型,从而简化了开发过程、降低了出错的风险,并提高了 API 的可维护性。

GraphQL 类型系统的基础

GraphQL 的类型系统由两种基本类型组成:标量类型和对象类型。

标量类型是简单的值类型,例如字符串、数字和布尔值。GraphQL 提供了一些内置的标量类型,比如 StringIntFloatBooleanID。我们也可以自定义标量类型。

对象类型则表示由多个字段组成的复杂类型。每个字段都有一个名称和一个类型。类型可以是标量类型或其他对象类型。对象类型可以包含嵌套的对象类型,从而创建出非常复杂的数据结构。

GraphQL 还提供了两种特殊的类型:列表类型和非空类型。列表类型表示一个包含多个元素的数组,非空类型表示一个不能为空的值。

在 GraphQL 中定义类型

在 GraphQL 中,我们使用 type 关键字来定义类型。例如,下面是一个简单的对象类型定义:

---- ---- -
  ------ ------
  ------- ------
  ------------ ------
-

这个定义表示一个名为 Book 的对象类型,包含三个标量类型字段:titleauthorpublishedAt

我们也可以定义一个列表类型:

---- ----- -
  ------ ------
-

这个定义表示一个名为 Query 的对象类型,包含一个名为 books 的字段,它返回一个 Book 对象类型的列表。

还可以定义一个非空类型:

---- ----- -
  -------- ----- ----
-

这个定义表示一个名为 Query 的对象类型,包含一个名为 book 的字段,它接受一个名为 id 的非空 ID 类型参数,并返回一个 Book 对象类型。

在 GraphQL 中使用类型

在 GraphQL 中,我们使用类型来定义查询和变异。查询是用来获取数据的操作,变异是用来修改数据的操作。

例如,下面是一个查询,它获取所有图书的标题和作者:

----- -
  ----- -
    -----
    ------
  -
-

这个查询返回一个对象,包含一个名为 books 的字段,它包含一个 Book 对象类型的列表,列表中每个对象包含 titleauthor 两个字段。

还可以定义一个带参数的查询:

----- -
  -------- ------ -
    -----
    ------
  -
-

这个查询返回一个对象,包含一个名为 book 的字段,它接受一个名为 idID 类型参数,并返回一个 Book 对象类型,包含 titleauthor 两个字段。

GraphQL 类型系统的优势

GraphQL 的类型系统提供了很多优势。以下是其中一些:

明确的 API 契约

GraphQL 的类型系统让 API 契约更加明确和可维护。开发人员可以立即了解每个字段的类型和用途,从而更轻松地编写正确的查询和变异。客户端也可以更轻松地了解如何使用 API,因为它们可以查看 API 的类型定义和文档。

减少文档和代码

GraphQL 的类型系统可以减少文档和代码量。开发人员不再需要编写大量的文档来描述 API 的使用方式,因为这些信息已经包含在类型定义中。客户端也不再需要编写大量的代码来解析和验证响应数据,因为它们可以利用类型系统自动完成这些任务。

更好的错误处理

GraphQL 的类型系统可以提供更好的错误处理。由于类型系统可以明确指定每个字段的类型,因此在查询和变异中出现错误时,GraphQL 可以更轻松地识别问题并提供更有用的错误消息。

示例代码

以下是一个简单的 Node.js GraphQL 服务器示例,它定义了一个 Book 对象类型和一个 Query 对象类型,包含一个 books 字段和一个 book 字段,可以用于获取图书列表和单个图书信息:

----- - ------------- --- - - -------------------------

----- -------- - ----
  ---- ---- -
    ------ ------
    ------- ------
    ------------ ------
  -

  ---- ----- -
    ------ ------
    -------- ----- ----
  -
--

----- ----- - -
  - --- ---- ------ ---- ----- -------- ------- --- ----- ------------ ------------ ------ --
  - --- ---- ------ --- ---- - ------------- ------- ------- ----- ------------ ------ --
  - --- ---- ------ ------- ------- ------- -------- ------------ ------ --
--

----- --------- - -
  ------ -
    ------ -- -- ------
    ----- --- - -- -- -- --------------- -- ------- --- ----
  --
--

----- ------ - --- -------------- --------- --------- ---

----------------------- --- -- -- -
  ------------------- ----- -- ---------
---

我们可以使用 GraphQL Playground 或其他客户端工具来测试这个服务器。例如,下面是一个查询,它获取所有图书的标题和作者:

----- -
  ----- -
    -----
    ------
  -
-

这个查询返回一个对象,包含一个名为 books 的字段,它包含一个 Book 对象类型的列表,列表中每个对象包含 titleauthor 两个字段。

还可以定义一个带参数的查询:

----- -
  -------- ---- -
    -----
    ------
  -
-

这个查询返回一个对象,包含一个名为 book 的字段,它接受一个名为 idID 类型参数,并返回一个 Book 对象类型,包含 titleauthor 两个字段。

结论

GraphQL 的类型系统是它最重要的特性之一。它可以让我们在定义 API 时就明确参数和返回值的类型,从而简化了开发过程、降低了出错的风险,并提高了 API 的可维护性。如果你还没有使用 GraphQL,那么我强烈建议你尝试一下,并体验其强大的类型系统带来的优势。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/6725d8d22e7021665e18e1be