前言
在开发前端项目中，我们通常使用前端框架来快速构建应用，并使用 npm 包来增强应用功能。在这篇文章中，我们将介绍一个 npm 包 sails-graphql-bolts，它可以使我们快速创建 sails 应用的 GraphQL API。本文将详细介绍如何使用 sails-graphql-bolts 来构建 GraphQL API，并提供示例代码，希望对读者有所帮助。
什么是 sails-graphql-bolts
sails-graphql-bolts 是一个 npm 包，它使用 GraphQL 和 sails.js 框架来创建 GraphQL API。sails-graphql-bolts 根据 sails 模型自动生成 GraphQL 查询和变异，同时也支持自定义解析器和模式。
要求
在使用 sails-graphql-bolts 之前，您需要确保您的开发环境中已经安装了以下内容：
- node.js：建议安装 LTS 版本。
- sails.js：通过以下命令进行全局安装
npm install sails -g。 - mongodb：可选，如果您计划使用数据库，则需要安装并配置好 mongodb。
安装
我们可以使用以下命令在项目中安装 sails-graphql-bolts：
npm install sails-graphql-bolts --save
使用 sails-graphql-bolts
在安装 sails-graphql-bolts 后，我们可以在 sails 项目中创建一个新的控制器，该控制器将公开我们的 GraphQL API。接下来，我们将演示如何创建和使用 sails-graphql-bolts。
创建控制器
首先，我们需要在 sails 项目中创建一个控制器。您可以使用 sails 命令来创建新的控制器或使用以下命令创建 graphql 控制器：
sails generate controller graphql
初始化控制器
接下来，我们需要初始化我们的控制器，将 sails-graphql-bolts 添加到我们的控制器中。在初始化之前，我们需要先创建一个 sails 模型。在本教程中，我们将创建一个 user 模型，并使用 sails-mongo 适配器将其连接到 mongodb 数据库。您可以使用以下命令创建 user 模型：
sails generate model user name:string email:string
然后，在您的 sails 项目中打开生成的 config/datastores.js 文件，将 default 数据库更改为您的数据库配置：
default: {
adapter: 'sails-mongo',
url: 'mongodb://localhost:27017/mydatabase',
},现在，我们已经创建了 user 模型，让我们开始初始化我们的控制器。打开 api/controllers/graphql.js 文件，并添加以下代码：
-- -------------------- ---- -------
----- ------ - -------------------------------
----- ---------------- - --------------------------
----- ---- - --- ------
------- -
----- --------------
--
-------- ---------
---
-------------- - -
----- ---------- ---- -
----- ------ - ----- ---------------------
------ -----------------
--
----- ------------- ---- -
----- ------ - ----- --------------------
------ -----------------
--
--在此示例中，我们首先引入并实例化 bolt。我们将使用 UserController 模型来操作 user 模型。使用 apiName 字段，我们将为我们的 GraphQL API 指定名称。最后，我们将在 query 和 mutation 方法中使用 bolt.exec 方法来执行 GraphQL 查询和变异。
模型定义
接下来，我们需要在 api/models 目录中创建 User.js 文件，该文件将定义我们的 user 模型。让我们打开 User.js 文件并添加以下代码：
-- -------------------- ---- -------
----- ----------- -------------- ------------------ --------------- - -------------------
----- ---- - -
----------- -
----- -
----- ---------
--------- ----
--
------ -
----- ---------
--------- -----
------- ----
-
-
--
----- -------- - --- -------------------
----- -------
------- -
--- -
----- ---------
--
----- -
----- -----------------------------
--
------ -
----- -----------------------------
-
-
---
-------------- - -
----- -----
--------- --------
--在上面的代码中，我们首先定义了 User 对象，它将充当 sails 模型的定义。接下来，我们定义了 UserType GraphQL 对象类型，该类型映射到 User 模型。
我们定义了 UserType 中的三个字段，分别是 id、name 和 email。id 字段使用 GraphQLID 类型，该类型映射到字符串。name 和 email 字段都是 GraphQLString 类型。
测试 API
现在我们已经完成了控制器和模型的设置，让我们测试一下我们的 API。在您的终端中，使用以下命令启动 sails 项目：
sails lift
启动成功后，我们可以使用 GraphQL Playground 来测试我们的 API。在浏览器中打开以下网址：http://localhost:1337/graphql 。您将看到 GraphQL Playground 界面。
接下来，您可以使用以下查询来获取所有用户：
{
users {
id
name
email
}
}如果一切正常，您应该会看到以下响应：
{
"data": {
"users": []
}
}由于我们还没有添加任何用户，所以返回一个空数组。
现在，让我们添加一个新的用户。使用以下变异来添加用户：
mutation {
createUser(name: "John Doe", email: "john@example.com") {
id
name
email
}
}如果一切正常，您应该会看到以下响应：
-- -------------------- ---- -------
-
------- -
------------- -
----- ---------------------------
------- ----- -----
-------- ------------------
-
-
-现在，让我们再次获取所有用户，查询如下：
{
users {
id
name
email
}
}现在您应该可以看到返回以下结果：
-- -------------------- ---- -------
-
------- -
-------- -
-
----- ---------------------------
------- ----- -----
-------- ------------------
-
-
-
-结论
sails-graphql-bolts 是一个强大且易于使用的 npm 包，它可以帮助我们快速构建 sails 应用的 GraphQL API。在本文中，我们已经详细介绍了如何使用 sails-graphql-bolts 来构建 GraphQL API，并提供了示例代码。我们希望这篇文章可以帮助您更快地构建 sails 应用程序，提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055bb281e8991b448d94db