npm 包 graphql-middleware-typed-arguments 使用教程

前言

GraphQL 是一种用于构建 API 的语言，它将 API 定义为类型和字段的集合，而不是固定的端点。GraphQL 的主要优势之一是它允许客户端按需获取所需的数据，而不是返回整个响应。

然而，当我们编写 GraphQL API 时，我们需要验证输入参数并处理错误。要解决这个问题，我们可以使用中间件函数。在这篇文章中，我们将介绍一个 npm 包叫做 graphql-middleware-typed-arguments，它提供了一种轻松处理 GraphQL 输入参数的方法。

什么是 graphql-middleware-typed-arguments？

graphql-middleware-typed-arguments 是一个 GraphQL 中间件，它可以在参数解析过程中自动检查参数的类型，验证参数是否存在，并处理错误。此外，该中间件还提供了可以快速生成 TypeScript 类型的工具函数。

如何使用 graphql-middleware-typed-arguments？

在使用 graphql-middleware-typed-arguments 之前，我们需要先安装和配置 GraphQL。

安装

在项目目录下使用 npm 安装 graphql-middleware-typed-arguments。

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

配置

在我们的 GraphQL 服务中，我们需要使用 graphql-middleware-typed-arguments 包装我们的解析器。下面是使用 GraphQL.js 的示例：

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

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

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

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

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

在上面的示例代码中，我们首先定义了一个 GraphQL schema。然后，我们在 resolver 函数中使用中间件包装器 applyMiddleware。我们将 typedFields 函数作为第一个参数传递给 applyMiddleware。该函数是 graphql-middleware-typed-arguments 提供的。接下来的参数是我们的 resolver 函数。

在这个例子中，我们定义了一个 user 查询，它需要一个 ID 类型的参数。我们使用 typedFields 函数检查传入的参数是否正确，并对传入参数进行处理。

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

中间件使用示例

下面，让我们看一个更复杂的例子来演示 graphql-middleware-typed-arguments 的使用。

示例代码

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

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

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

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

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

在上面的代码中，我们定义了一个包含 user 和 createUser 两个操作的 GraphQL schema。

user 操作需要 id、name 和 email 参数。我们在 resolver 函数中使用 applyMiddleware 函数将 typedFields 中间件包装在 resolver 上。如果在客户端传递的参数不符合上述定义，将会抛出 TypedFieldsError 或 MissingFieldsError 错误。

createUser 操作需要 input 参数，并且该参数包含 name 和 email 字段。在 resolver 函数中，我们除了检查 input 这个参数外还需要检查输入的参数 name 和 email。

总结

使用中间件是处理 GraphQL 输入参数的一个非常方便的方法。graphql-middleware-typed-arguments 是一个辅助我们处理 GraphQL 输入参数的 npm 包，它能更好地解决参数验证和错误处理的问题。在应用 GraphQL 开发时，我们应该考虑使用此中间件来增加服务的健壮性，避免出现参数错误等问题，提高项目开发的效率和质量。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60066b5751ab1864dac66dc2

阅读全文

猜你喜欢

  • npm 包 c4webservice 使用教程

    在前端开发中，我们经常需要使用后台服务接口。而在 Node.js 环境中，有一个强大的包管理工具 npm，通过 npm 包我们可以方便地使用各种接口库。其中，c4webservice 是一款常用的 W...

    3 年前
  • npm 包 rodys-cp 使用教程

    在前端开发中，常常需要进行文件复制、剪切、删除等操作。npm 中有很多工具包可以实现这些操作，而 rodys-cp 是其中一个简单易用的包，能够实现复制和剪切文件的功能。

    3 年前
  • npm 包 remembera 使用教程

    前言 在前端开发中，我们经常会使用各种 npm 包，这些包能够大大提高我们的开发效率。其中，remembera 这个 npm 包可以帮助我们实现数据持久化，让我们的应用程序更加稳定。

    3 年前
  • NPM包cordova-plugin-redhatcat-imagepicker使用教程

    简介 Cordova-plugin-redhatcat-imagepicker是一个为Cordova和Ionic框架提供支持的NPM包，其主要功能是方便地从设备相册或相机中选择和获取图像。

    3 年前
  • npm包react-progressive-list-typescript使用教程

    简介 react-progressive-list-typescript是一个React组件库，用于构建大数据量列表和表格。与大多数React列表和表格组件不同，此组件库专注于性能。

    3 年前
  • npm包@waynecz/ui-recorder使用教程

    前言 在前端领域，我们经常需要测试自己的代码，尤其是在研发自己的UI组件库时，我们需要对组件的功能进行测试。通常，我们会使用录制工具来模拟用户对组件的操作行为。在此，我们为大家介绍一款npm包@way...

    3 年前
  • npm 包 chartjs-chart-radial-gauge 使用教程

    前言 在前端开发中，常常需要使用图表来展示数据，而 Chart.js 是一款优秀的图表库，它简单易用，支持多种类型的图表。而本文介绍的 npm 包 chartjs-chart-radial-gauge...

    3 年前
  • npm 包 Webshot-factory 使用教程

    前言 在 Web 开发中，我们经常需要将网页转换为图片或 PDF 文件。原生 JavaScript 并不能直接完成这项任务，但我们可以使用 npm 包 Webshot-factory 来帮助我们，该 ...

    3 年前
  • npm 包 graphql-to-sql 使用教程

    简介 graphql-to-sql 是一款基于 Node.js 的 npm 包，它的功能是将 GraphQL 查询语句转换为 SQL 语句。这个包的出现使得前端开发在使用 GraphQL 时，不再需要...

    3 年前
  • npm 包 fluent-grapesjs 使用教程

    在前端开发中，我们常常需要使用各种第三方库来提高开发效率和代码质量。其中，npm 是前端开发中最常用的包管理器之一。而 fluent-grapesjs 则是一个基于 Grapesjs 构建的 UI 套...

    3 年前
  • npm包 @cocopina/transform-keys使用教程

    前言 在很多前端开发项目中，我们常常需要对 JavaScript 对象的键（key）进行转换，例如将驼峰式命名转为下划线式命名、将下划线式命名转为驼峰式命名等。手动进行转换过程可能比较繁琐，所以我们可...

    3 年前
  • npm包@ccurtin/mui-datatables使用教程

    前言 前端开发者处理数据表格是比较常见的一项工作，而 mui-datatables 是一个基于 Material-UI 的 React 数据表格组件。但是时间管理效率非常低，所以本文介绍的是另一款前端...

    3 年前
  • npm 包 @pawbor/maybe 使用教程

    前言 在前端开发中，我们经常需要处理可能为 null 或 undefined 的数据，而频繁的判断和处理这些情况会使代码变得复杂而且难以维护。这时就可以使用 Maybe 函数库来简化这个过程。

    3 年前
  • npm 包 dibk-wizard-framework 使用教程

    本文将介绍如何使用 npm 包 dibk-wizard-framework 来创建一个交互式向导组件。 作为一个前端开发人员，我们经常需要在应用程序中实现一个向导流程，以引导用户完成某些特定任务。

    3 年前
  • npm 包 json-sv 使用教程

    1. 简介 在前端开发中，我们经常需要处理 JSON 数据。JSON Schema Validator 是一个常用的工具，用于验证 JSON 数据的正确性和规范性，而 json-sv 就是针对 JSO...

    3 年前
  • npm包jsonld-stable-stringify使用教程

    在使用JavaScript编写Web应用程序时，经常需要将JSON数据序列化为字符串。JSON数据是基于JavaScript对象的，其结构可以无限扩展。但是，当我们使用JSON.stringify()...

    3 年前
  • npm 包 liyad-lisp-pkg-example 使用教程

    介绍 liyad-lisp-pkg-example 是一个基于 JavaScript 的 lisp 语言解释器，以 npm 包的形式发布。它支持所有符合 Lisp 语法的表达式，并且可以自定义函数和宏...

    3 年前
  • npm 包 @pinguinosod/david-test 使用教程

    简介 npm 是一个 Node.js 的包管理工具，开发者可以通过它方便地查找、安装和管理应用程序的依赖包。@pinguinosod/david-test 是一个基于 npm 构建的前端包，提供了 J...

    3 年前
  • NPM包Autofont使用教程

    #NPM包Autofont使用教程 在前端开发中，我们经常需要考虑不同的设备和屏幕尺寸。这就要求我们在设计和开发过程中使用一种自适应的方式来处理字体大小。这时，Autofont就是一个非常好用的工具。

    3 年前
  • npm 包 generator-psmodule 使用教程

    在前端开发过程中，我们经常需要编写一些小的 JavaScript 模块，以便满足项目的需求。这些模块有时会被多个项目所共用，因此我们需要将它们封装成 npm 包并发布到 npm 上，方便其他项目引用。

    3 年前

相关推荐

    暂无文章