GraphQL 是一种用于 API 的查询语言，它提供了强大的查询和类型系统，能够优化 Web 应用的性能和开发效率。Node.js 生态系统中的一个重要工具是 npm 包管理器，它允许我们轻松地安装和管理依赖项。本文将介绍如何使用 npm 包 graphql-ts 来开发 GraphQL API 服务。
什么是 graphql-ts？
graphql-ts 是一个开源 npm 包，它允许我们通过 TypeScript 类型来定义 GraphQL schema，以提高代码的可靠性和开发效率。graphql-ts 使用了基于装饰器和 TypeScript 类型的声明式编程模型，使得 GraphQL schema 的定义更加简洁和易于维护。
安装和配置
首先，我们需要运行以下命令来安装 graphql-ts 和它的依赖项：
npm install graphql graphql-tools reflect-metadata npm install --save-dev graphql-ts
然后，我们需要在项目的 TypeScript 配置文件中启用实验性的装饰器和元数据支持（如果你已经启用了这些特性，可以跳过这一步）：
{
"compilerOptions": {
"experimentalDecorators": true,
"emitDecoratorMetadata": true
}
}现在我们已经完成了配置，接下来我们可以开始开发 GraphQL API 服务了。
开发 GraphQL schema
我们需要创建一个 ts 文件，定义 GraphQL 的 schema 和每个 query/mutation 的处理函数。以下是一个简单的例子：
-- -------------------- ---- -------
------ - ------ --------- ----------- ----- - ---- ------------
-------------
----- ---- -
-------- --- ------
-------- ------ ------
-------- ------- ------
-
--------
------ -------- -------- ------ -
------ -
- --- ---- ------ ------ ------------ ------- ----- ------ --
- --- ---- ------ -------- ----- ------- ------ ----- -
-
-
-----------
------ -------- ----------- ------- ------ ------- ------- -------- ---- -
----- ---- - - --- ------ ------ -
-- ---- --- ---- -- --- -----------
------ ----
-在上面的代码中，我们先定义了一个 GraphQL 类型 Book，它包含三个字段 id、title 和 author。然后，我们使用装饰器 @Query() 和 @Mutation() 来声明查询函数和修改函数，它们分别对应 GraphQL schema 中的 query 和 mutation。
创建 GraphQL 服务
我们需要创建一个 Express 应用并将 graphql-ts 中间件挂载到路由上。以下是一个示例：
-- -------------------- ---- ------- ------ - -- ------- ---- --------- ------ - ---------------- - ---- ------------ ----- --- - --------- ------------------- ------------------ ------- -------------- --------- ---- --- ---------------- -- -- - -------------------- ------ -- ------- -- ------------------------------- --
在上面的代码中，我们首先创建了 Express 应用，然后使用 graphqlTsExpress 创建一个 GraphQL 中间件，并挂载到路径 /graphql 上。其中，schema 参数是我们自定义的 GraphQL schema，graphiql 参数设置为 true 允许我们在浏览器中访问 GraphQL Playground。
测试 GraphQL API
现在我们可以使用 Postman 或类似的工具来测试我们的 GraphQL API 服务。以下是一些示例请求：
-- -------------------- ---- -------
- ------
----- -
----- -
--
-----
------
-
-
- ------
-------- -
----------- ---- ------ -------- -- ------ ------- ----- ------- -
--
-----
------
-
-以上请求将会返回对应的 JSON 结果，我们可以在浏览器中访问 GraphQL Playground 来可视化查看结果和调试。
结束语
graphql-ts 是一个优秀的 npm 包，它让我们可以使用 TypeScript 类型来编写 GraphQL schema，提高了代码的可维护性和方便性。在本文中，我们介绍了如何安装和配置 graphql-ts，并给出了一个简单的示例。希望这篇文章对你在开发 GraphQL API 服务时有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055fdb81e8991b448dd769