GraphQL API - 使用 Prisma 部署实战指南

阅读时长 6 分钟读完

GraphQL是一种先进的API设计语言。它的强大之处在于可以根据客户端的需要返回特定的数据。而Prisma则是一款流行的ORM框架,其旨在帮助开发者简单地构建和管理数据库模式与访问数据库。

本文将教你如何使用Prisma和GraphQL构建并部署你的API。

步骤1:安装Prisma CLI

首先,你需要在你的电脑上安装Prisma CLI。Prisma CLI是一个命令行工具,用于在本地和云中创建和管理Prisma服务。你可以在终端中输入以下命令行来安装:

安装完成后,你可以输入以下命令来检查Prisma CLI是否安装成功:

步骤2:创建Prisma服务

在安装Prisma CLI之后,你需要创建一个Prisma服务,用于管理你的数据库。Prisma CLI提供了一个简单的命令行可以帮助你完成这一步骤:

该命令将创建一个名为"my-app"的Prisma服务并初始化其默认设置。在初始化过程中,你需要选择一款适用于你项目的数据库。

你可以在终端中输入以下命令行来检查你创建的Prisma服务:

步骤3:使用Prisma构建数据模型

你需要在你的数据库中创建一个数据模型以便Prisma能够与之交互。数据模型定义了数据库的结构和约束条件。

在"my-app"文件夹中创建一个新的文件夹,命名为"prisma",并在其中创建一个新的文件,命名为"schema.prisma"。在该文件中定义你的数据模型。以下是一个名为"User"的数据模型示例:

在该示例中,你定义了一个名为"User"的数据模型,具有四个属性:id、name、email和password。其中,id属性自增且作为唯一标识符。email属性是唯一的(不能重复)。

步骤4:使用Prisma CLI生成Prisma客户端

现在,你需要使用Prisma CLI生成一个Prisma客户端,该客户端将通过GraphQL API与你的数据库交互。该客户端基于你在步骤3中定义的数据模型。你可以使用以下命令行来创建你的Prisma客户端:

执行完该命令后,一个新的文件夹"node_modules/@prisma/client"就会自动创建。该文件夹中就是你的Prisma客户端。

步骤5:使用GraphQL构建API

现在,你需要使用GraphQL构建API,以便客户端能够与数据库交互。你可以在"my-app"文件夹中创建一个新的文件夹,命名为"src",并在其中创建一个新文件,命名为"index.js"。

在该文件中,你需要编写代码,使用Prisma客户端来查询和修改你的数据库。

以下是使用GraphQL构建API的示例代码:

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

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

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

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

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

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

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

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

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

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

在该示例代码中,你定义了三种GraphQL类型:User、Query和Mutation。其中,User类型表示你的数据库中的用户,Query类型表示你的API中的查询方法,Mutation类型表示你的API中的修改方法(例如create、update、delete)。

示例代码中的resolvers是一个对象,它包含了所有GraphQL类型的解析方法。查询解析方法使用Prisma客户端查询用户数据;修改解析方法使用Prisma客户端修改用户数据。

最后,你需要启动GraphQL服务器,以便客户端可以访问你的API。你可以使用以下命令行来启动你的GraphQL服务器:

步骤6:部署你的API

如果你想要将你的API部署到生产环境中,可以使用prisma deploy命令。该命令将会将你的API部署到Prisma服务中。以下是命令行示例:

执行命令后,你需要按照指示进行操作。你需要选择你想要部署到的Prisma服务(例如Prisma Cloud),并输入你的数据库管理凭证。

经过以上步骤,你的API已经到处部署成功。你可以使用图形化界面的Prisma Studio来查看和修改你的数据库。如下面的命令可以启动Prisma Studio:

结论

本文介绍了如何使用Prisma和GraphQL构建和部署API。通过本文,你将学习到了如何使用Prisma CLI创建服务、使用Prisma CLI生成客户端、使用GraphQL构建API,以及如何部署你的API到生产环境中。

使用Prisma和GraphQL可以简化API的开发流程,提高API的可维护性和可扩展性。同时,Prisma的自动化数据库管理功能也使得数据库维护更加简单和高效。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/670cf01c5f551281025c0e6c

纠错
反馈