将 GraphQL 引入 NestJS 应用程序

在现代 Web 开发中,GraphQL 是一个非常流行的 API 定义语言。它可以简化 API 设计,提高前端性能并消除 API 更新的版本控制问题。在 NestJS 应用程序中使用 GraphQL 可以提供更好的查询执行控制,并且不需要在路由中分析请求参数。

本篇文章将会详细介绍如何在 NestJS 应用程序中使用 GraphQL。我们将介绍如何配置应用程序来使用 GraphQL,如何创建 GraphQL schema,并且如何编写 GraphQL resolver。

准备工作

在开始之前,我们需要安装 NestJS 和 GraphQL 库:

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

配置应用程序

首先,我们需要在应用程序中配置 GraphQL。

在 NestJS 中,我们可以使用 GraphQLModule 来配置 GraphQL。只需要将其添加到应用程序的模块中,并传递一些配置参数,例如:GraphQL schema。在 imports 属性中添加 GraphQLModule。我们还需要使用 ForRoot() 方法为应用程序提供配置参数。

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

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

在上面的代码中,我们做了以下配置:

  • autoSchemaFile: 用于生成 GraphQL schema 的输出路径。这表示,将会有一个名为 schema.gql 的文件存储自动生成的 schema。
  • imports: 我们将 GraphQLModule 添加到 AppModule 的 imports 数组中。

这样我们就配置了 GraphQLModule。

创建 GraphQL resolver

接下来,我们需要创建并定义 GraphQL resolver。Resolver 负责接收客户端发起的请求,并执行相应的数据库操作。

打开你的控制器文件夹,并创建一个新的 resolver。在这里我们将使用 @Resolver() 装饰器来定义我们的 GraphQL 查询。

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

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

在示例代码中,我们创建了一个名为 CatResolver 的 resolver。我们使用了 @Query() 装饰器来定义指向查询之间的映射。 然后我们执行了一个 hello() 函数并返回一个字符串。

编写 GraphQL schema

接下来,我们需要定义用来描述数据的类型。 schema 定义了数据类型并说明查询能够返回的数据。

在 NestJS 中,我们可以使用 Graphql-tools 来定义 schema。简单地说,schema 就是一个描述 API 功能的文档。

创建一个新文件 src/schema.graphql ,并定义 GraphQL 的查询类型和返回值。在示例代码中,我们定义了 hello() 函数,该函数返回一个字符串 "meow"

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

启动应用程序

最后,我们将要启动应用程序并测试我们的 GraphQL 端点。

为了测试我们的 hello 查询,我们将使用 Postman 将请求发送到 http://localhost:3000/graphql

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

在 Postman 中,构建一个 POST 请求:

-
    -----
-

我们可以看到在响应中,我们得到了我们在 resolver 中定义的字符串 "meow"

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

总结

在本文中,我们介绍了如何在 NestJS 应用程序中使用 GraphQL。我们了解了如何配置应用程序和定义 GraphQL schema 和 resolver。将 GraphQL 引入 NestJS 应用程序可以提高代码的可读性和可维护性,简化前后端之间的沟通,同时也能够简化 API 设计和查询执行过程。

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


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    2 个月前