npm包graphql-express-nodejs使用教程

前言

GraphQL 是一种用于 API 的查询语言。GraphQL 通过定义类型和对类型的查询、操作和订阅的结构来描述 API,使用 GraphQL 客户端可以精确地进行数据查询,任意粒度的执行查询操作,只需发送一个请求即可获取到所需数据,而不是像传统RESTful API一样获取所有数据甚至是不必要的数据。GraphQL 在前端领域得到了广泛的应用和追捧,而 graphql-express-nodejs 则是一个相对易用的 GraphQL 的 Node.js 实现,其构建在 graphql、express 和 node.js 之上,并得到了众多Node.js开发者的喜爱。

安装graphql-express-nodejs

在开始使用 graphql-express-nodejs 前,我们需要首先安装这个包,可以通过 npm 安装,命令如下:

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

搭建GraphQL服务器

  1. 安装依赖

在你的项目目录下,使用 npm 安装必要的依赖:

--- ------- ------ ------- ------- ----------------------
  1. 初始化GraphQL中间件

在你的应用程序的入口文件中使用 graphql-express-nodejs 为应用程序创建 GraphQL 中间件。只需要在 Express 应用程序中调用 graphqlExpress() 函数:

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

其中的 schema 是一个包含数据模型和查询的对象,在 GraphQL 中描述了 API 的类型系统。schema 可以使用类似 graphql-tools 之类的模块定义,其内容超出了本篇文章的范围,我们只做简单介绍。

  1. 创建示例 schema

在本教程中,我们将创建一个简单的 GraphQL schema,用于演示 graphql-express-nodejs 的工作原理。

先安装 graphql 和 graphql-tools:

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

创建一个名为 schema.js 的文件。

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

在此例子中,我们使用了 typeDefs 定义了三个类型(Book, Query, Mutation),并在 resolvers 中实现了它们的功能,使用 GraphQLClient 发送相应的请求即可调用这些函数,得到对应的结果。

  1. 初始化Express

创建我们的入口文件(index.js),并导入必要的库。在这个示例中,我们使用了 express 和 body-parser 库。

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

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

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

在这个示例中,我们创建了一个 Express 应用程序,并使用 body-parser 来解析 GraphQL 请求体。我们还调用了 graphqlExpress() 方法,来将创建好的中间件挂载到 /graphql 路径上。

  1. 启动服务器

使用 node index.js 命令启动我们的服务器,在控制台中交互式的运行我们的请求,获取对应的数据。

GraphQL 请求方法

我们在示例代码中使用了方法名为 graphqlExpress() 的 GraphQL 中间件,它是基于 Express 的静态方法;此中间件由 GraphQL 所提供,用于执行 GraphQL 查询语句。让我们看一下这个中间件可接受的一些参数:

  • schema: 必选,GraphQL schema 对象。
  • context: 上下文对象,GraphQL 查询的内部使用,用于存储全局变量,例如数据库连接等。
  • rootValue: 请求处理程序从 schema 中读取的可选根值。如果未指定,默认根值设置为 request 对象。
  • graphiql: 可选的,Boolean 类型,如果为 true, 中间件将安装 GraphiQL 用户界面,用户界面可通过浏览器打开,它支持测试和 IDE 的功能。

GraphQL 请求示例

使用 GraphQL 客户端发送查询请求来获取数据,就像这样:

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

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

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

在上述请求中,我们使用了两种类型的请求,一种是查询请求,另一种是变更请求,通过这样的方式我们往往可以更为准确的获取我们需求的数据。

结语

本文向您展示了如何使用 graphql-express-nodejs 构建 GraphQL服务器,并针对示例进行了讲解,供各位前端开发者参考。GraphQL 的 API查询语言消除了RESTful的不足之处,并且还是未来的一种发展趋势,希望通过本文向大家传达了 GraphQL 的初步使用,帮助大家更快的掌握这个技术并提高项目的开发效率。

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


猜你喜欢

  • npm包lerna-dependency-checker使用教程

    在开发前端项目时,我们通常需要使用许多第三方包来构建我们的应用程序。但是,如果你使用了多个包管理工具,例如npm或yarn,并且在多个项目之间共享代码,那么你可能会遇到一些依赖重复或不兼容的问题。

    3 年前
  • npm 包 topunet-net-functions 使用教程

    介绍 npm 包 topunet-net-functions 是一个集成了多种网络通讯功能的 JavaScript 库,它可以帮助前端工程师快速地实现对 network 层的各种操作。

    3 年前
  • npm 包 rrrrr-request 使用教程

    前言 在前端开发过程中,发送请求是非常常见的操作。为了更好地处理和控制请求,我们通常会使用一些成熟的请求库。npm上有很多优秀的请求库,其中 rrrrr-request 是一个轻巧易用且功能强大的库,...

    3 年前
  • npm 包 storybook-markdown-jsx 使用教程

    前言 在前端开发中,我们常常需要编写文档或说明文本。而随着组件化的趋势不断发展,原先的文本格式已无法满足需求。此时,markdown 作为一种专门用于编写文档的语言应运而生。

    3 年前
  • npm 包 webpack-entry-watcher 使用教程

    1. 前言 随着前端技术的不断发展,打包工具已经成为了前端开发的必备工具之一。而在一些较大的项目中,会有很多入口文件需要打包,这时候如果每个文件都手动去启动 webpack 来打包,势必会浪费我们大量...

    3 年前
  • NPM 包 Easy-Bunny 使用教程

    在前端开发中,我们经常需要使用各种第三方库和工具来辅助我们完成项目开发。其中,npm 是一个流行的包管理器,提供了大量的开源包供我们使用。在这篇文章中,我们将介绍一个便捷的 npm 包 Easy-Bu...

    3 年前
  • npm 包 react-generate 使用教程

    在前端开发中,我们通常需要使用一些 UI 组件库来快速构建界面,比如 Ant Design、Bootstrap 等。但是,有时候这些组件库里的组件并不能满足我们某些特定的需求,这时候我们就需要自己写组...

    3 年前
  • npm 包 @ionepub/node-timer 使用教程

    前言 在前端开发中,时间是非常重要的一个因素。在一些具有计时功能的场景中,频繁地使用setInterval和setTimeout等原生 JS 方法难免会带来代码不易维护和调试等问题。

    3 年前
  • npm 包 dgitals-blocks 使用教程

    介绍 dgitals-blocks 是一个基于 Vue.js 的 UI 组件库,主要用于快速构建前端界面。它提供了诸如表格、表单、图表等丰富的组件,同时具有高度的可定制性和扩展性。

    3 年前
  • npm 包 iamale-unistore 使用教程

    简介 iamale-unistore 是一个基于 unistore 框架的 npm 包,旨在为前端开发者提供更加方便快捷的状态管理功能。该包提供了一系列简单易用的 API,可以让开发者更加轻松地管理应...

    3 年前
  • npm 包 dom-form-submit 使用教程

    介绍 在前端开发中,经常需要提交表单数据,并将数据保存至后端数据库。在传统的表单提交过程中,我们需要写大量的 JavaScript 代码,以获取表单数据并将其发送至后端。

    3 年前
  • npm 包 serverless-micro 使用教程

    前言 近年来,Serverless 架构在云计算领域得到了广泛应用,它可以使开发者只专注于实现业务逻辑,而无需考虑服务器等基础设施的运维问题。本篇文章介绍一个名为 serverless-micro 的...

    3 年前
  • npm 包 sulk 使用教程

    前言 在现代化的前端技术中,使用 npm 包已经成为开发中必不可少的一部分。其中,sulk 是一个非常有用的 npm 包,它可以用来快速构建用户界面、编写组件和处理路由。

    3 年前
  • npm 包 wee-node 使用教程

    在前端开发中,我们经常会使用各种第三方库来提高工作效率和代码质量。其中,npm 是前端最常用的包管理器之一,它提供了海量的优秀包供我们使用。在这篇文章中,我们将介绍一个非常实用的 npm 包:wee-...

    3 年前
  • npm 包 flexible.js 使用教程

    介绍 在移动端开发中,为了适应不同分辨率的手机以及不同屏幕的方向,我们需要使用自适应布局。flexible.js 是一个非常优秀的 npm 包,它可以很好地帮助我们实现自适应布局。

    3 年前
  • npm 包 marom 使用教程

    npm 是前端开发中必不可少的一个包管理工具,marom 是一款基于 npm 的前端模板引擎,它能够将模板数据与模板文件结合起来,最终生成目标文件。 本文将从以下几个部分来介绍 marom 的使用教程...

    3 年前
  • npm 包 tmijs-es5 使用教程

    前言 tmijs-es5 是一款基于 Twitch 的 IRC 聊天室协议封装的 npm 包,适用于在前端 Web 应用中集成 Twitch 聊天室功能。本教程将为您详细介绍如何使用 tmijs-es...

    3 年前
  • npm 包 vue-left-slide 使用教程

    简介 vue-left-slide 是一款提供左滑菜单功能的 Vue.js 组件,可以方便地为 Vue.js Web 应用程序添加左滑菜单功能。本文将详细介绍如何使用 vue-left-slide。

    3 年前
  • npm 包 cockpit-orm 使用教程

    前言 随着前端开发的迅猛发展,很多新技术、新工具相继出现。npm 是前端开发中最常用的包管理工具之一,而 cockpit-orm 是一款非常好用的 npm 包,它为前端开发人员提供了简化操作数据库的功...

    3 年前
  • npm 包 npm-overlapping-marker-spiderfier 使用教程

    如果你正在开发前端项目,并且需要在地图上标记多个位置时,你可能会遇到重叠标记的问题。在这种情况下,npm-overlapping-marker-spiderfier 是一种非常有用的 npm 包,可以...

    3 年前

相关推荐

    暂无文章