如何从 GraphQL 模式生成 GraphQL 操作

Question

我正在寻找一种方法，让开发人员在使用 GraphQL 时更高效。

目前，使用 graphql-code-generator 从前端的 GraphQL 服务器生成类型。

这很好，但这只是生成类型。为了生成突变、查询和订阅的方法，我需要为前端项目中的每个操作创建一个 GraphQL 文档，例如：

file addPost.graphql

mutation addPost {
...
}
...

我发现必须创建一个额外的 addPost.graphql 来生成该方法有点多余，因为它已经在我的 GraphQL 服务器上声明了。

是否有 plugin/configuration 可以生成我可以在我的项目中使用的这些方法，而无需手动创建额外的 GraphQL 文档？

这是我的 GraphQL 生成器 yml 文件

# graphql-generator.yml
overwrite: true
schema: https://localhost:8088/query
documents: ./libs/**/*.graphql          <----- generating these *.graphql files would be great! 
generates:
  libs/graphql/src/lib/generated/graphql.ts:
    plugins:
      - "typescript"
      - "typescript-resolvers"
      - "typescript-operations"
      - "typescript-apollo-angular"
  ./graphql.schema.json:
    plugins:
      - "introspection"

Answer 1

GraphQL 的核心概念之一是允许组件或任何其他消费者选择他们需要的字段的能力，而不是其他东西为他们决定（后端开发人员/服务器/代码）。

此外，基于 GraphQL 架构生成操作很棘手 - 由于图形的性质，您无法在没有一组约束的情况下真正生成它（例如：要达到什么嵌套级别？如何处理）循环链接？在参数的情况下你会怎么做？如果模式发生变化怎么办？等等）

GraphQL 代码生成器没有这样做，因为我们认为使用 GraphQL 层的开发人员应该决定字段。

在我们开发的其他一些解决方案中，我们需要这样的工具来生成选择集，但有一些 pre-defined 限制。此评论总结了它并提供了生成这些的代码示例：https://github.com/dotansimha/graphql-code-generator/discussions/2349#discussioncomment-15754

如果您愿意，您可以将它们生成到一个文件中，然后将其提供给 codegen，或者您可以在您的项目中创建一个自定义文档加载器以动态创建它 (https://graphql-code-generator.com/docs/getting-started/documents-field#custom-document-loader)

Answer 2

另见 https://github.com/timqian/gql-generator

Generate queries from graphql schema, used for writing api test.

This tool generate 3 folders holding the queries: mutations, queries and subscriptions

如何从 GraphQL 模式生成 GraphQL 操作

How to generate GraphQL operations from GraphQL schema

typescript

graphql

apollo-client

graphql-codegen