GraphQL 是一种现代的 API 查询语言，由 Facebook 在 2012 年开发并于 2015 年开源。它不仅能够明确地定义 API 与客户端之间的数据需求，还能够避免多次请求数据和发送过多数据到前端等问题。require-graphql 是一个 npm 包，它使要求 GraphQL Schema 文件和查询变得更加容易，同时也保证代码的清晰度。
安装 require-graphql
在使用 require-graphql 之前，需要在项目中安装这个 npm 包：
npm install --save require-graphql
引入 require-graphql
安装完毕后，可以在项目中引入 require-graphql：
const { makeExecutableSchema } = require('graphql-tools')
const requireGraphQL = require('require-graphql-file')
const typeDefs = requireGraphQL('./schema.graphql')在这个示例代码中，我们使用 requireGraphQL 引入一份名为 schema.graphql 的 GraphQL schema。makeExecutableSchema 是 graphql-tools 包中的一个函数，它使用定义好的 GraphQL schema 和解析器函数来定义一个可执行的 GraphQL schema。要使 makeExecutableSchema 正常工作，需要使用 requireGraphQL 来引入需要的 schema。
使用 require-graphql 定义类型
在 GraphQL 中，类型是重要的概念，它定义了 API 的数据模型。require-graphql 使得定义类型变得更加容易和直观。下面是一个简单的示例代码：
type Query {
hello: String!
}
type Mutation {
setMessage(message: String!): String!
}在上面的示例中，我们定义了两种类型：Query 和 Mutation。Query 类型定义了查询操作，它们仅仅是读取数据，不会修改数据。而 Mutation 定义了修改数据的 API。它们的子字段定义了属性及其类型。在这个例子中，hello 查询会返回一个字符串，setMessage 操作会接受一个字符串作为参数，并返回一个字符串。
使用 require-graphql 定义查询和变量
require-graphql 还可以帮助我们定义查询和变量。下面是一个例子：
query getMessage($name: String) {
getMessage(name: $name)
}在这个示例中，我们定义了一个名为 getMessage 的查询，并为其定义了一个参数 name。我们可以使用 require-graphql 引入类似这样的查询文件，并立即使用它。
-- -------------------- ---- ------- ----- - ------- - - ------------------ ----- -------------- - ------------------------------- ----- ------ - ---------------------- --------- ---------------------------------- -- ----- ----- - -------------------------------------- --------------- ------ ----- ----- - ----- ------- -------------- -- - ------------------- --
在上面的示例代码中，我们使用 requireGraphQL 引入了一个名为 getMessage 的查询，并使用 graphql 函数执行这个查询。在这个示例中，我们将 name 的值设置为 world。
使用 require-graphql 配置选项
require-graphql 还有许多其他的选项，可以帮助我们定制化我们的 graphql 文件。下面是一些示例：
// 可选的选项
requireGraphQL('./example.graphql', { parseOptions: { noLocation: true }, stripComments: true })在这个例子中，我们传递了两个选项：
- parseOptions: 可以传递用于解析 GraphQL 文件的选项。
- stripComments: bool。是否需要解析文件中的注释。默认为 false。
通过这些选项，我们可以更好地定制我们的 GraphQL 文件。
总结
在本文中，我们学习了如何使用 npm 包 require-graphql 来访问和配置一个 GraphQL Schema 和一些查询。这个包可以帮助我们更加容易地定义类型、变量和查询，并且可以让我们定制化一些选项。我们希望本文能够帮助大家更好地理解 require-graphql 的使用，并提供一些有益的技巧和指导。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600668e1d9381d61a354096c