REST API 是现代 Web 开发中不可或缺的一部分。然而，使用传统的 RESTful API 开发方式，开发者需要手动编写数据模型、数据库查询和路由等代码，这往往会让开发过程变得繁琐和复杂。本文将介绍如何使用 Prisma 和 GraphQL 创建 REST API，让开发者更加高效和轻松地开发 API。
Prisma 和 GraphQL 简介
Prisma 是一个现代化的 ORM（Object-Relational Mapping）框架，它可以帮助开发者更加轻松地访问数据库。Prisma 支持多种数据库，包括 PostgreSQL、MySQL 和 SQLite 等。Prisma 还提供了命令行工具，可以用来生成数据模型、数据库迁移和客户端代码等。
GraphQL 是一种新兴的 API 开发方式，它可以帮助开发者更加灵活地定义 API 接口。GraphQL 允许客户端精确地指定需要获取的数据，从而避免了传统 REST API 中常见的“过度获取”问题。GraphQL 还提供了强大的类型系统和查询语言，可以帮助开发者更加轻松地开发和维护 API。
接下来，我们将使用 Prisma 和 GraphQL 创建一个简单的 REST API，演示如何使用这两个工具来简化 API 开发过程。
步骤一：安装 Prisma 和 GraphQL
首先，我们需要安装 Prisma 和 GraphQL。可以使用 npm 或 yarn 安装这两个工具：
--- ------- ------ ------- - -- ---- --- ------ -------
步骤二：定义数据模型
接下来，我们需要定义数据模型。在这个例子中，我们将创建一个简单的博客应用，包含两个数据模型：用户和文章。
在项目根目录下创建一个 prisma/schema.prisma 文件，定义数据模型：
---------- -- - -------- - ------------ --- - ------------------- - --------- ------ - -------- - ------------------ - ----- ---- - -- --- --- ------------------------- ---- ------ ----- ------ ------- -------- ------ ----- ------ - ----- ---- - -- --- --- ------------------------- ----- ------ ------- ------ ------ ---- ----------------- ----------- ----------- ----- -------- --- --------- -------- --------------- -
这个数据模型定义了两个实体：User 和 Post。User 实体包含 id、name、email 和 password 四个字段，Post 实体包含 id、title、content、authorId 和 createdAt 五个字段。User 和 Post 之间是一对多的关系，一个用户可以发布多篇文章。
步骤三：生成 Prisma 客户端代码
接下来，我们需要使用 Prisma 命令行工具生成客户端代码。在命令行中执行以下命令：
--- ------ -------- - -- ---- ------ --------
这个命令会根据 schema.prisma 文件生成 Prisma 客户端代码，包括数据模型的类型定义和数据库访问方法等。
步骤四：定义 GraphQL schema
接下来，我们需要定义 GraphQL schema。在项目根目录下创建一个 src/schema.graphql 文件，定义 GraphQL schema：
---- ----- - ------ -------- -------- ------ ---- ------ -------- -------- ------ ---- - ---- -------- - ---------------- -------- ------ -------- --------- --------- ----- ----------------- -------- -------- -------- --------- ------ ----- - ---- ---- - --- ---- ----- ------- ------ ------- --------- ------- ------ -------- - ---- ---- - --- ---- ------ ------- -------- ------- ------- ----- ---------- ------- -
这个 GraphQL schema 定义了查询和变更两个操作，以及 User 和 Post 两个类型。Query 类型定义了查询操作，包括 users、user、posts 和 post 四个字段。Mutation 类型定义了变更操作，包括 createUser 和 createPost 两个字段。User 和 Post 类型定义了实体的属性。
步骤五：实现 GraphQL resolvers
接下来，我们需要实现 GraphQL resolvers。在项目根目录下创建一个 src/resolvers.js 文件，实现 resolvers：
----- --------- - -
------ -
------ ----- -------- ----- - ------ -- -- -
------ -----------------------
--
----- ----- -------- - -- -- - ------ -- -- -
------ ------------------------ ------ - -- - ---
--
------ ----- -------- ----- - ------ -- -- -
------ -----------------------
--
----- ----- -------- - -- -- - ------ -- -- -
------ ------------------------ ------ - -- - ---
--
--
--------- -
----------- ----- -------- - ----- ------ -------- -- - ------ -- -- -
------ -------------------- ----- - ----- ------ -------- - ---
--
----------- ----- -------- - ------ -------- -------- -- - ------ -- -- -
------ -------------------- ----- - ------ -------- -------- - ---
--
--
----- -
------ ----- -------- ----- - ------ -- -- -
------ ------------------------ ------ - --- --------- - -----------
--
--
----- -
------- ----- -------- ----- - ------ -- -- -
------ ------------------------ ------ - --- --------- - ------------
--
--
--
-------------- - ----------这个文件实现了 Query 和 Mutation 两个操作的 resolvers，以及 User 和 Post 两个类型的 resolvers。在 resolvers 中，我们使用 Prisma 客户端代码访问数据库，实现了查询和变更操作。
步骤六：实现 GraphQL server
最后，我们需要实现 GraphQL server。在项目根目录下创建一个 src/index.js 文件，实现 GraphQL server：
----- - ------------ - - ------------------------- ----- - ------------ - - -------------------------- ----- -------- - ---------------------------- ----- --------- - ----------------------- ----- ------ - --- --------------- ----- ------ - --- -------------- --------- ---------- -------- -- -- -- ------ --- --- ----------------------- --- -- -- - ------------------- ----- -- --------- ---
这个文件创建了一个 ApolloServer 实例，并将 GraphQL schema 和 resolvers 注入到 server 中。在 context 中，我们将 Prisma 客户端代码传递给 resolvers，以便 resolvers 可以访问数据库。
步骤七：测试 API
现在，我们已经创建了一个完整的 REST API，可以使用任何 GraphQL 客户端来测试它。例如，我们可以使用 GraphiQL（一个基于浏览器的 GraphQL IDE）来测试 API。
打开浏览器，访问 http://localhost:4000，可以看到 GraphiQL 的界面。在左侧的查询窗口中，输入以下查询：
----- -
----- -
--
----
-----
----- -
--
-----
-------
-
-
-这个查询会返回所有用户及其发布的文章。点击右侧的“运行”按钮，可以看到查询结果。
接下来，我们可以使用 GraphiQL 的“变更”功能来创建新的用户和文章。例如，输入以下变更：
-------- -
---------------- -------- ------ -------------------- --------- --------- -
--
----
-----
-
-这个变更会创建一个名为“Alice”的用户，并返回用户的 ID、姓名和邮箱。同样地，我们也可以创建新的文章：
-------- -
----------------- ------ ------- -------- ----- -- -- ----- ------ --------- -- -
--
-----
-------
------ -
--
----
-----
-
-
-这个变更会创建一篇标题为“Hello World”的文章，并将其分配给 ID 为 1 的用户。变更还会返回文章的 ID、标题、内容和作者信息。
至此，我们已经成功地使用 Prisma 和 GraphQL 创建了一个简单的 REST API。
总结
Prisma 和 GraphQL 是两个非常强大的工具，可以帮助开发者更加高效和轻松地开发 REST API。使用 Prisma 和 GraphQL，开发者可以更加方便地定义数据模型、访问数据库和实现 API 接口。本文演示了如何使用 Prisma 和 GraphQL 创建一个简单的博客应用，介绍了具体的实现步骤和注意事项。希望本文对读者有所帮助，能够启发读者更深入地了解和掌握这两个工具。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/656d7236d2f5e1655d5b55b6