如何使用 GraphQL 和 Prisma 实现后端 API

在传统的后端 API 开发中，开发者需要自行编写数据库查询、定义数据类型及其关系以及 API 接口。而 GraphQL 和 Prisma 的出现，则可简化这 一过程。GraphQL 是一种用于 API 的查询语言，而 Prisma 可以帮助我们管理数据模型。

因此，这篇文章主要介绍如何使用 GraphQL 和 Prisma 实现后端 API。我们将通过以下步骤逐一实现：

  1. 创建 Prisma 数据模型
  2. 创建 GraphQL schema 和 resolver
  3. 将 GraphQL API 与 Prisma 数据库集成
  4. 使用 Prisma 客户端进行数据库操作

前置条件：

  • 已经安装 Node.js 和 npm。
  • 具备基础的 JavaScript 和 GraphQL 知识。

1. 创建 Prisma 数据模型

首先我们需要安装 Prisma。在命令行中输入：

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

接下来，在项目根目录下运行以下命令生成 Prisma 配置文件和数据模型文件：

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

这个命令会自动生成一个 prisma 目录和相应的文件，如图所示：

现在，我们需要打开 prisma/schema.prisma 文件，并定义我们的数据模型。假设我们需要管理学生和教师信息，我们可以这样来定义：

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

这里，我们定义了一个 db 数据源，可以指向我们的 PostgreSQL 数据库。在本例中，假设我们使用的是本地的 PostgreSQL 数据库，端口为 5432，数据库名字为 mydatabase。

我们还定义了两个模型：Student 和 Teacher。其中，Student 模型有 id、name、age、gpa 和 major 字段，Teacher 模型有 id、name、age 和 title 字段。

现在，我们需要在命令行中运行以下命令来同步 Prisma 数据模型到数据库中：

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

这个命令将自动创建数据库表和字段，并将 Prisma 数据模型同步到数据库中。

2. 创建 GraphQL schema 和 resolver

接下来，我们需要定义一个 GraphQL schema 和 resolver 来实现我们的业务逻辑。我们需要先安装 graphql 和 apollo-server。

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

然后在项目根目录中创建以下三个文件：

-
--- ----
-   --- --------------
-   --- ------------
-   --- --------
--- ------------
  • schema.graphql：定义 GraphQL schema。
  • resolvers.js：定义 resolver 函数。
  • index.js：开启 Apollo Server。

我们需要在 schema.graphql 中定义我们的 GraphQL schema。对于我们的学生和教师信息管理业务，我们可以这样定义：

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

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

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

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

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

这里，我们定义了两个类型：Student 和 Teacher，分别对应我们的数据模型。对于查询，我们定义了 Query 类型，其中包括 students、student、teachers 和 teacher 四个字段。对于 CRUD 操作，我们定义了 Mutation 类型，其中包括 createStudent、updateStudent、deleteStudent、createTeacher、updateTeacher 和 deleteTeacher 六个字段。

接下来，我们需要在 resolvers.js 文件中定义 resolver 函数。我们可以按照以下方式定义：

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

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

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

这里，我们通过 PrismaClient 类来实例化一个 Prisma 客户端，用于与数据库交互。在 resolvers 中，我们定义了 Query 和 Mutation 的各个字段，通过 Prisma 客户端实现相应的查询、更新、删除操作。

最后，我们需要在 index.js 文件中开启 Apollo Server，将 GraphQL schema 和 resolver 作为参数传入。

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

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

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

现在，我们可以在命令行中执行：

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

来启动 Apollo Server。

3. 将 GraphQL API 与 Prisma 数据库集成

目前，我们已经实现了 GraphQL API 和后端 Prisma 数据库操作的功能。但是，我们的 GraphQL API 并没有与 Prisma 数据库进行集成。因此，我们需要在 prisma/schema.prisma 中定义我们的 Query 和 Mutation 类型：

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

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

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

不难看出，这里的 Query 和 Mutation 类型与我们在 schema.graphql 文件中的定义一致，只是加了一些类型和参数。

接下来，我们需要在命令行中执行以下命令来同步 Prisma 数据模型和 GraphQL schema：

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

这样，Prisma 会自动生成与 GraphQL schema、TypeScript 类型和 CRUD resolver 相关的代码。

4. 使用 Prisma 客户端进行数据库操作

现在，我们已经完成了 GraphQL API 和 Prisma 数据库的集成，可以使用 Prisma 客户端来操作数据库了。以下是一些示例代码：

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

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

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

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

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

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

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

以上代码定义了一些函数，用于实现学生信息的增、删、改、查等操作。使用 Prisma 客户端时，我们只需要调用相应的方法（如 prisma.student.create()、prisma.student.update()、prisma.student.delete()、prisma.student.findUnique()、prisma.student.findMany() 等）即可。

总结

本文介绍了如何使用 GraphQL 和 Prisma 实现后端 API。我们首先定义了 Prisma 数据模型，然后创建了 GraphQL schema 和 resolver，进而将 GraphQL API 与 Prisma 数据库集成。最后，我们展示了如何使用 Prisma 客户端来操作数据库。这些内容都可以作为借鉴和学习的参考资料。

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

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

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

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

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

    1 个月前
  • ECMAScript 2020（ES11）中的新特性：BigInt 转换

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

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

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

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

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

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

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

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

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

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

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

    1 个月前
  • 解析 TypeScript 中 encapsulation（封装）的实现方式

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

    1 个月前
  • PM2 崩溃处理：如何避免由于 PM2 进程奔溃导致应用崩溃？

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    1 个月前
  • Tailwind CSS 如何实现动态换肤？

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

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

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

    1 个月前

相关推荐

    暂无文章