npm 包 @graphql-toolkit/graphql-file-loader 使用教程

GraphQL 是一种用于 API 的查询语言,同时也是一个满足你数据查询的运行时。GraphQL 对你的 API 中所提供的数据设定了一套统一的、易用的、强大的、可操作的 API,同时对你的应用程序所面临的查询,变更,和订阅等方面也同样具备相关能力。

GraphQL 可以看作一个是 API 的中间层,协调服务端和客户端间的数据交互。在 Node.js 中使用 GraphQL 提供的工具可以大大方便我们的开发。

graphql-file-loader 是一个使得我们可以在 .js 或 .ts 文件中书写 GraphQL Schema 或者模拟客户端请求的工具,可以帮助我们在开发中更加快速的进行 schema 的开发。

安装

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

使用

在 .js 或者 .ts 等文件中使用 graphql-file-loader

通过 import 或者 require 引入的 GraphQL 模块,我们可以把 .graphql 文件中的语句传递给 graphql-parse,就可以对其中的 GraphQL 语句进行编译和操控。在加载模块时,webpack 会查找 .graphql 文件,自动调用该 loader 并把它当成一个模块调入。

在 webpack.config.js 中加入规则

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

在代码中引用 .graphql

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

或者,使用 require:

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

我们也可以在代码中继续使用 gql 解析出来的字符串:

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

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

将 .graphql 文件编译为 .js

可以先编写好 GraphQL Schema 语句并保存在 .graphql 文件中,然后利用 graphql-file-loader 对其进行编译并生成一个 js 文件,最后再将生成的 js 文件作为一个普通 js 文件进行引用,就可以直接使用其中的 schema 语句。

举个例子,在新建一个 helloworld.graphql 文件,然后进行以下定义:

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

GraphQL 视极简代码规范为生死攸关,尤其在建立定义好的 Schema 命名时,使用数据源名称作为前缀命名。

若命名为 Hello World,则会出现正则等相关复杂操作时的无法预知错误。

接着,我们在 package.json 中新建以下内容:

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

并在项目根目录下写入 codegen.yml 的配置文件,如下:

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

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

webpack.config.js 指定 loader:

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

我们可以直接使用 import 命令或通过 require 的方法,将编译后的文件作为模块导入:

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

或者:

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

使用演示

示例代码如下(假设在文件路径 src/graphql/schema.graphql 文件中有以下 Schema 定义):

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

创建resolvers.js文件:

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

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

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

创建 index.js 文件:

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

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

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

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

在项目根目录下执行:

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

便可以看到控制台输出以下信息:

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

至此,通过 webpack 和 graphql-file-loader 工具,我们可以很方便地对 GraphQL Schema 语句进行管理,并且可以在代码中引用已经对 GraphQL Schema 语句进行了编译的文件,而不用担心 GraphQL Schema 语句过于庞大导致代码难以维护的问题。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5eedaeb7b5cbfe1ea0610ebe


猜你喜欢

  • npm 包 @opentelemetry/core 使用教程

    前言 @opentelemetry/core 是一个用于构建分布式系统、监控和调度的 JavaScript 库。作为开放性业界标准 OpenTelemetry 的核心组件之一,@opentelemet...

    4 年前
  • npm 包 @opentelemetry/resources 使用教程

    前言 在现代化的应用程序或服务中,追踪和监控应用程序的关键性能指标是必要的。OpenTelemetry 是一个开源的框架,用于生成和处理跟踪,指标和日志数据。@opentelemetry/resour...

    4 年前
  • npm 包 @opentelemetry/tracing 使用教程

    介绍 在前端开发中,追踪应用程序的性能和错误是非常重要和必要的。@opentelemetry/tracing 是一个开源的 Node.js 库,它提供了一种可扩展的、可靠的方法来追踪前端应用程序的性能...

    4 年前
  • npm 包 @activeledger/activecontracts 使用教程

    在前端开发中,我们经常需要使用第三方包来实现一些功能。而在区块链开发中,@activeledger/activecontracts 是一个很好用的 npm 包,可以帮助我们实现一些与智能合约相关的操作...

    4 年前
  • npm 包 @ledgerhq/errors 使用教程

    在前端开发中,经常需要处理不同的错误情况。@ledgerhq/errors 是一个 Node.js 的 npm 包,可以用来处理 Ledger 设备上发生的错误。在本篇文章中,我们将详细介绍如何安装和...

    4 年前
  • npm包 @ledgerhq/devices的使用教程

    前言 在前端开发中,随着加密货币的普及,越来越多的应用需要与硬件钱包进行交互。而@ledgerhq设备的npm包,提供了一种便捷的方式,让开发者可以方便地与硬件钱包进行交互。

    4 年前
  • npm 包 @ledgerhq/hw-transport 使用教程

    介绍 @ledgerhq/hw-transport 是一个用于与硬件钱包通信的 npm 包,支持多种类型的硬件钱包,包括 Ledger Nano S,Ledger Nano X等。

    4 年前
  • npm 包 @activeledger/activetoolkits 使用教程

    在前端开发中,我们经常需要使用一些工具库来帮助我们完成开发任务。其中,npm 包是常用的工具之一。在这篇文章中,我们将介绍一个常用的 npm 包 @activeledger/activetoolkit...

    4 年前
  • npm包@types/solidity-parser-antlr使用教程

    简介 @types/solidity-parser-antlr是npm上的一个TypeScript类型定义包,用于在TypeScript中调用solidity-parser-antlr。

    4 年前
  • npm 包 solidity-parser-antlr 使用教程

    Solidity 是一种智能合约的编程语言,而 solidity-parser-antlr 则是一种 npm 包,可以帮助开发人员将 Solidity 合约解析成抽象语法树(AST)。

    4 年前
  • npm 包 @ledgerhq/logs 使用教程

    在前端开发中,处理和调试日志是非常重要的一项功能。钱包应用程序如 Ledger,也需要有一个强大的日志记录功能,以便其开发人员在处理问题时能够得到准确的信息。这就是为什么 @ledgerhq/logs...

    4 年前
  • npm 包 @types/ethereum-protocol 使用教程

    在开发区块链和去中心化应用程序时,Ethereum 是一种非常流行的平台。如果您打算使用 TypeScript 开发 Ethereum 应用程序,那么 @types/ethereum-protocol...

    4 年前
  • npm 包 u2f-api 使用教程

    简介 在 Web 应用程序中,强大的用户身份认证方法是必不可少的一种安全保障。通常情况下,用户名和密码已经成为了 Web 身份验证最基本的组成部分。然而,在一些重要的安全场合,单单凭借用户名和密码的验...

    4 年前
  • npm 包 es-get-iterator 使用教程

    什么是 es-get-iterator 包 es-get-iterator 是一个 npm 包,它提供了一种迭代 ES6 中的可迭代对象的方法。通过使用 es-get-iterator 包,我们不必使...

    4 年前
  • npm 包 iterate-iterator 使用教程

    iterate-iterator 是一个非常实用的 npm 包,可以帮助前端开发人员更加灵活和高效地操作数组和迭代器。本文将介绍该 npm 包的使用方法,以及其深入的功能和学习指导意义。

    4 年前
  • npm 包 glob-exec 使用教程

    前言 在前端开发中,我们经常需要对文件进行操作,如查找满足一定规则的文件、删除指定文件等。这时候,我们可以使用 npm 包 glob-exec 来轻松实现这些操作。

    4 年前
  • npm 包 has-bigints 使用教程

    随着 JavaScript 语法和运行环境的不断升级和完善,BigInt 类型也逐渐得到了广泛的支持。BigInt 类型可以表示任意大的整数,与传统的 Number 类型对比,它能够提供更高的精度,更...

    4 年前
  • npm 包 ts-lib-utils 使用教程

    什么是 ts-lib-utils ts-lib-utils 是一个能够提供常用的 TypeScript 工具函数的 npm 包。它包含了各种类型的能够提高 TypeScript 代码质量的工具函数,例...

    4 年前
  • npm 包 Type-Coverage-Core 使用教程

    在前端开发中,我们经常需要对代码进行类型检查,以提高代码开发和维护的效率和准确性。而 NPM 包 Type-Coverage-Core 就提供了一种快速方便的方式来检查 TypeScript 项目中的...

    4 年前
  • npm包 @foray1010/common-presets-utils使用教程

    简介 @foray1010/common-presets-utils是一个功能强大且易于使用的npm包,专门为前端开发人员提供解决方案。它提供了一系列的通用预设,可以在各种前端项目中使用。

    4 年前

相关推荐

    暂无文章