在 Deno 中使用 GraphQL 实现 API

阅读时长 10 分钟读完

前言

GraphQL 是一种由 Facebook 开发的数据查询语言和执行引擎，它不依赖于任何特定的数据库或存储引擎，可以对任何数据源进行查询。Deno 是一个新的 JavaScript 和 TypeScript 运行时，它提供了一种安全的方式运行 JavaScript，可以使用 TypeScript 编写代码并脱离 Node.js 运行。本文将介绍如何在 Deno 中使用 GraphQL 实现 API，涵盖 GraphQL 基本知识和 Deno 中使用 GraphQL 的具体实现方法。

GraphQL 基础知识

GraphQL 是一种基于 schema 的查询语言，它通过定义类型、接口、枚举和联合类型来表示数据结构。GraphQL 查询语言具有很强的灵活性，客户端可以在查询中指定所需的字段、关系和过滤条件，避免了传统 REST API 中需要多次请求的问题。GraphQL 的查询语言和服务端实现之间通过 schema 定义进行交互，schema 定义由三个根元素组成：Query、Mutation 和 Subscription。

  • Query: 用于查询数据，类似于 REST API 的 GET 方法，返回一个或多个对象。
  • Mutation: 用于修改数据，类似于 REST API 的 POST、PUT、DELETE 方法。
  • Subscription: 用于订阅数据，可以在服务器端推送数据到客户端。

GraphQL 中的类型有两类：标量类型和复合类型。标量类型包括 String、Int、Float、Boolean 和 ID，可以直接作为字段类型。复合类型包括 Object、Interface、Union 和 Enum，可以包含标量类型、其他复合类型和自身类型，可以作为类型的字段类型。

GraphQL 中的查询语言由查询字段、查询别名、查询参数、查询指令和查询片段组成。查询字段表示所需的数据，查询别名用于指定返回数据的字段名，查询参数用于指定查询的参数，查询指令用于影响查询结果，查询片段用于重复利用查询结果的一部分。

Deno 中使用 GraphQL 实现 API 需要使用第三方库，本文介绍使用 oak_graphql 和 graphql_extensions。oak_graphql 是基于 Oak 的 GraphQL 服务器，graphql_extensions 则是一个 GraphQL 扩展库，可以在 schema 中添加扩展信息。

步骤一：安装依赖

安装 oak_graphql 和 graphql_extensions：

步骤二：编写 schema

在 Deno 中使用 GraphQL 需要编写 schema，定义 Query、Mutation 和 Subscription，以及类型信息。举个例子，我们定义一个基于 todo 的 API：

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

上面的 schema 定义了 Todo 类型、Query 类型、Mutation 类型和根 schema。其中 Todo 类型包含 id、text 和 done 字段，Query 类型包含 todos 和 todo 两个字段，Mutation 类型包含 addTodo 和 toggleDone 两个字段。

步骤三：编写 resolver

编写 resolver，将 schema 中的定义映射到具体的函数实现。举个例子，我们使用 SQLite 数据库存储数据，当执行 todo 查询时，查询数据库中的数据并返回：

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

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

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

上面的代码中，我们定义了两个查询函数 todos 和 todo，用于查询所有的 todo 和查询指定的 todo，定义了两个 Mutation 函数 addTodo 和 toggleDone，用于添加和修改 todo。同时我们添加 Type 函数 Todo，将数据库中的查询结果映射为 GraphQL API 中的返回结果。

步骤四：启动服务器

启动服务器，使用 oak_graphql 创建 GraphQL API：

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

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

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

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

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

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

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

总结

本文介绍了在 Deno 中使用 GraphQL 实现 API 的具体步骤，包括安装 oak_graphql 和 graphql_extensions，编写 schema，编写 resolver 和启动服务器。Deno 的出现为前端开发提供了更多的选择，而 GraphQL 则是一种更灵活、高效的 API 设计方式。希望本文可以对初学者有所启发，让大家更深入地了解 GraphQL 和 Deno。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64ab991848841e9894768224

纠错
反馈
相关推荐
精选内容