npm 包 graphql-to-json-schema 使用教程

什么是 graphql-to-json-schema ?

graphql-to-json-schema 是一个能够将 GraphQL 查询转换成 JSON 模式的 npm 包。它可以帮助开发人员更加容易地创建 mock 数据，以便在开发早期进行本地开发和测试。

如何使用 graphql-to-json-schema ?

安装

要使用 graphql-to-json-schema，请首先在项目目录下运行以下命令进行安装：

npm install graphql-to-json-schema

示例代码

接下来，让我们看一下如何使用 graphql-to-json-schema 来创建一个简单的 mock 数据。假设我们的 GraphQL schema 为：

type Query {
  name: String!
  age: Int!
}

在该 schema 中，我们具有两个字段，分别是 name 和 age。

为了使用 graphql-to-json-schema 创建 mock 数据，我们需要熟悉以下几个命令：

parse

parse 命令将我们的 GraphQL schema 转换为 JSON 模式。我们需要在 parse 命令中指定以下三个参数：

• schema: 我们的 GraphQL schema
• dest: 输出 JSON 模式的目标路径
• lineLength: 输出的 JSON 模式的行长度，默认是 120 个字符

在 CLI 中，我们可以这样使用 parse 命令：

./node_modules/.bin/gts parse --schema schema.graphql --dest schema.json

在这个命令中，我们将 schema.graphql 作为输入，并将结果输出到 schema.json。

mock

mock 命令将我们的 JSON 模式转换为 mock 数据。我们需要在 mock 命令中指定以下两个参数：

• schema: 我们的 JSON 模式
• dest: 输出 mock 数据的目标路径

在 CLI 中，我们可以这样使用 mock 命令：

./node_modules/.bin/gts mock --schema schema.json --dest mock.json

在这个命令中，我们将 schema.json 作为输入，并将结果输出到 mock.json。

完整示例

在这个示例中，我们将使用上面的 schema 创建 mock 数据。

schema.graphql

type Query {
  name: String!
  age: Int!
}

CLI 命令

./node_modules/.bin/gts parse --schema schema.graphql --dest schema.json
./node_modules/.bin/gts mock --schema schema.json --dest mock.json

mock.json

{
  "name": "Lorem ipsum",
  "age": 25
}

总结

graphql-to-json-schema 使得使用 GraphQL 的开发工作变得更加容易和方便。通过使用 graphql-to-json-schema，我们可以更快地创建 mock 数据，并在开发早期进行本地开发和测试。

希望这篇文章能够帮助你理解如何使用 graphql-to-json-schema。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056cdc81e8991b448e68c3