获取 GraphQL 整个架构查询

Question

我想从服务器获取架构。 我可以获取具有类型的所有实体，但无法获取属性。

获取所有类型：

query {
  __schema {
    queryType {
      fields {
        name
        type {
          kind
          ofType {
            kind
            name
          }
        }
      }
    }
  }
}

如何获取类型的属性：

__type(name: "Person") {
    kind
    name
    fields {
      name
      type {
        kind
        name
        description
      }
    }
  }

如何仅在 1 个请求中获取具有属性的所有类型？ 或者更好：我怎样才能获得带有突变器、枚举、类型的整个模式......

Answer 1

更新

现在推荐使用graphql-cli来获取和更新架构。

以下命令将帮助您入门：

# install via NPM
npm install -g graphql-cli

# Setup your .graphqlconfig file (configure endpoints + schema path)
graphql init

# Download the schema from the server
graphql get-schema

您甚至可以通过运行以下命令来监听架构更改并不断更新您的架构：

graphql get-schema --watch

---

如果您只想下载 GraphQL 架构，请使用以下方法：

获取 GraphQL 模式的最简单方法是使用 CLI 工具get-graphql-schema 。

你可以通过 NPM 安装它：

npm install -g get-graphql-schema

有两种方法可以获取您的架构。 1) GraphQL IDL格式或 2) JSON 自省查询格式。

GraphQL IDL 格式

get-graphql-schema ENDPOINT_URL > schema.graphql

JSON自省格式

get-graphql-schema ENDPOINT_URL --json > schema.json

或者

get-graphql-schema ENDPOINT_URL -j > schema.json

更多信息可以参考以下教程： 如何下载 GraphQL IDL Schema

Answer 2

这是GraphiQL使用的查询（网络捕获）：

query IntrospectionQuery {
  __schema {
    queryType {
      name
    }
    mutationType {
      name
    }
    subscriptionType {
      name
    }
    types {
      ...FullType
    }
    directives {
      name
      description
      locations
      args {
        ...InputValue
      }
    }
  }
}

fragment FullType on __Type {
  kind
  name
  description
  fields(includeDeprecated: true) {
    name
    description
    args {
      ...InputValue
    }
    type {
      ...TypeRef
    }
    isDeprecated
    deprecationReason
  }
  inputFields {
    ...InputValue
  }
  interfaces {
    ...TypeRef
  }
  enumValues(includeDeprecated: true) {
    name
    description
    isDeprecated
    deprecationReason
  }
  possibleTypes {
    ...TypeRef
  }
}

fragment InputValue on __InputValue {
  name
  description
  type {
    ...TypeRef
  }
  defaultValue
}

fragment TypeRef on __Type {
  kind
  name
  ofType {
    kind
    name
    ofType {
      kind
      name
      ofType {
        kind
        name
        ofType {
          kind
          name
          ofType {
            kind
            name
            ofType {
              kind
              name
              ofType {
                kind
                name
              }
            }
          }
        }
      }
    }
  }
}

Answer 3

您可以使用 GraphQL-JS 的自省查询来获取您想了解的有关架构的所有信息：

import { introspectionQuery } from 'graphql';

如果你只想要类型的信息，你可以使用这个：

{
    __schema: {
        types: {
            ...fullType
        }
    }
}

它使用自省查询中的以下片段：

fragment FullType on __Type {
    kind
    name
    description
    fields(includeDeprecated: true) {
      name
      description
      args {
        ...InputValue
      }
      type {
        ...TypeRef
      }
      isDeprecated
      deprecationReason
    }
    inputFields {
      ...InputValue
    }
    interfaces {
      ...TypeRef
    }
    enumValues(includeDeprecated: true) {
      name
      description
      isDeprecated
      deprecationReason
    }
    possibleTypes {
      ...TypeRef
    }
  }
  fragment InputValue on __InputValue {
    name
    description
    type { ...TypeRef }
    defaultValue
  }
  fragment TypeRef on __Type {
    kind
    name
    ofType {
      kind
      name
      ofType {
        kind
        name
        ofType {
          kind
          name
          ofType {
            kind
            name
            ofType {
              kind
              name
              ofType {
                kind
                name
                ofType {
                  kind
                  name
                }
              }
            }
          }
        }
      }
    }
  }
`;

如果这看起来很复杂，那是因为字段可以任意深度包装在 nonNulls 和 Lists 中，这意味着从技术上讲，如果您的字段包装在 7 层以上（可能不是这种情况），即使上面的查询也不能反映完整的模式）。

您可以在此处查看 introspectionQuery 的源代码。

Answer 4

使用 阿波罗 cli ：

npx apollo schema:download --endpoint=http://localhost:4000/graphql schema.json

Answer 5

您可以使用 Hasura 的graphqurl实用程序

npm install -g graphqurl

gq <endpoint> --introspect > schema.graphql

# or if you want it in json
gq <endpoint> --introspect --format json > schema.json

完整文档： https ://github.com/hasura/graphqurl

Answer 6

您可以使用以下命令下载远程 GraphQL 服务器的架构。 命令成功后，您应该会在当前工作目录中看到一个名为schema.json的新文件。

~$ npx apollo-cli download-schema $GRAPHQL_URL --output schema.json

Answer 7

您可以将GraphQL-Codegen 与 ast-plugin 一起使用

npm install --save graphql
npm install --save-dev @graphql-codegen/cli
npx graphql-codegen init

按照步骤生成codegen.yml文件

安装该工具后，您可以使用该插件下载schema-ast 架构

最好是按照页面上的说明进行安装……但基本上：

npm install --save-dev @graphql-codegen/schema-ast

然后配置codegen.yml文件以设置哪些模式是/是事实的来源以及将下载的模式文件放在哪里：

schema:
  - 'http://localhost:3000/graphql'
generates:
  path/to/file.graphql:
    plugins:
      - schema-ast
    config:
      includeDirectives: true

Answer 8

更新

在厌倦了一直修改我以前的脚本之后，我屈服并制作了自己的 CLI 工具gql-sdl 。 我仍然找不到其他工具可以下载具有零配置的 GraphQL SDL，但我希望有一个工具存在。

基本用法：

$ gql-sdl https://api.github.com/graphql -H "Authorization: Bearer ghp_[redacted]"
directive @requiredCapabilities(requiredCapabilities: [String!]) on OBJECT | SCALAR | ARGUMENT_DEFINITION | INTERFACE | INPUT_OBJECT | FIELD_DEFINITION | ENUM | ENUM_VALUE | UNION | INPUT_FIELD_DEFINITION

"""Autogenerated input type of AbortQueuedMigrations"""
input AbortQueuedMigrationsInput {
  """The ID of the organization that is running the migrations."""
  ownerId: ID!

  """A unique identifier for the client performing the mutation."""
  clientMutationId: String
}
...

标头参数-H在技术上是可选的，但大多数 GraphQL API 需要通过标头进行身份验证。 您也可以改为下载 JSON 响应 ( --json )，但这是其他工具已经很好地服务的用例。

在后台，它仍然使用GraphQL.js提供的自省查询，因此如果您希望将此功能合并到您自己的代码中，请参阅下面的示例。

---

上一个答案

不知何故，我无法获得任何建议的 CLI 工具来输出 GraphQL 的模式定义语言 (SDL) 中的模式，而不是自省结果 JSON。 最后我拼凑了一个非常快速的 Node 脚本，让 GraphQL 库为我做这件事：

const fs = require("fs");
const { buildClientSchema, getIntrospectionQuery, printSchema } = require("graphql");
const fetch = require("node-fetch");

async function saveSchema(endpoint, filename) {
    const response = await fetch(endpoint, {
        method: "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify({ query: getIntrospectionQuery() })
    });
    const graphqlSchemaObj = buildClientSchema((await response.json()).data);
    const sdlString = printSchema(graphqlSchemaObj);
    fs.writeFileSync(filename, sdlString);
}

saveSchema("https://example.com/graphql", "schema.graphql");

getIntrospectionQuery()具有获取所有内容所需的完整自省查询，然后buildClientSchema()和printSchema()将 JSON 混乱转换为 GraphQL SDL。

将它变成 CLI 工具本身并不太难，但这感觉有点矫枉过正。

Answer 9

您可以使用 IntelliJ 插件JS GraphQL然后 IDEA 会要求您创建两个文件“graphql.config.json”和“graphql.schema.json”

然后您可以编辑“graphql.config.json”以指向您的本地或远程 GraphQL 服务器：

"schema": {
"README_request" : "To request the schema from a url instead, remove the 'file' JSON property above (and optionally delete the default graphql.schema.json file).",
"request": {
  "url" : "http://localhost:4000",
  "method" : "POST",
  "README_postIntrospectionQuery" : "Whether to POST an introspectionQuery to the url. If the url always returns the schema JSON, set to false and consider using GET",
  "postIntrospectionQuery" : true,
  "README_options" : "See the 'Options' section at https://github.com/then/then-request",
  "options" : {
    "headers": {
      "user-agent" : "JS GraphQL"
    }
  }
}

之后，IDEA 插件将自动从 GraphQL 服务器加载模式并在控制台中显示模式 json，如下所示：

Loaded schema from 'http://localhost:4000': {"data":{"__schema":{"queryType":{"name":"Query"},"mutationType":{"name":"Mutation"},"subscriptionType":null,"types":[{"kind":"OBJECT","name":"Query","description":"","fields":[{"name":"launche

Answer 10

我也在寻找并看到这篇关于 GraphQL 的 Medium 文章

以下查询返回了有关架构、查询及其输入和输出参数类型的许多详细信息。

fragment FullType on __Type {
  kind
  name
  fields(includeDeprecated: true) {
    name
    args {
      ...InputValue
    }
    type {
      ...TypeRef
    }
    isDeprecated
    deprecationReason
  }
  inputFields {
    ...InputValue
  }
  interfaces {
    ...TypeRef
  }
  enumValues(includeDeprecated: true) {
    name
    isDeprecated
    deprecationReason
  }
  possibleTypes {
    ...TypeRef
  }
}
fragment InputValue on __InputValue {
  name
  type {
    ...TypeRef
  }
  defaultValue
}
fragment TypeRef on __Type {
  kind
  name
  ofType {
    kind
    name
    ofType {
      kind
      name
      ofType {
        kind
        name
        ofType {
          kind
          name
          ofType {
            kind
            name
            ofType {
              kind
              name
              ofType {
                kind
                name
              }
            }
          }
        }
      }
    }
  }
}
query IntrospectionQuery {
  __schema {
    queryType {
      name
    }
    mutationType {
      name
    }
    types {
      ...FullType
    }
    directives {
      name
      locations
      args {
        ...InputValue
      }
    }
  }
}

Answer 11

参考https://stackoverflow.com/a/42010467/10189759

想指出，如果需要身份验证，您可能不能只使用从graphql init生成的配置文件

你可能需要做这样的事情，例如，使用 github graphql API

{
  "projects": {
    "graphqlProjectTestingGraphql": {
      "schemaPath": "schema.graphql",
      "extensions": {
        "endpoints": {
          "dev": {
            "url": "https://api.github.com/graphql",
            "headers": {
              "Authorization": "Bearer <Your token here>"
            }
          }
        }
      }
    }
  }
}

Answer 12

如果您想自己做，请阅读以下代码：

有一个模块化的 state-of-art 工具「graphql-cli」，考虑看看它。 它使用包「graphql」的 buildClientSchema 从自省数据构建 IDL .graphql 文件。

• graphql-cli get-schema：集成到 graphql-cli 第 1 部分
• graphql-config EndpointsExtension：集成到 graphql-cli 第 2 部分

Answer 13

1）安装get-graphql-schema（NPM）

npm install -g get-graphql-schema

2）使用它将架构下载到当前目录

get-graphql-schema API_ENDPOINT -j > schema.json

Answer 14

graphql npm 包的IntrospectionQuery 确实

query IntrospectionQuery {
    __schema {
        queryType {
            name
        }
        mutationType {
            name
        }
        subscriptionType {
            name
        }
        types {
            ...FullType
        }
        directives {
            name
            description

            locations
            args {
                ...InputValue
            }
        }
    }
}

fragment FullType on __Type {
    kind
    name
    description

    fields(includeDeprecated: true) {
        name
        description
        args {
            ...InputValue
        }
        type {
            ...TypeRef
        }
        isDeprecated
        deprecationReason
    }
    inputFields {
        ...InputValue
    }
    interfaces {
        ...TypeRef
    }
    enumValues(includeDeprecated: true) {
        name
        description
        isDeprecated
        deprecationReason
    }
    possibleTypes {
        ...TypeRef
    }
}

fragment InputValue on __InputValue {
    name
    description
    type {
        ...TypeRef
    }
    defaultValue
}

fragment TypeRef on __Type {
    kind
    name
    ofType {
        kind
        name
        ofType {
            kind
            name
            ofType {
                kind
                name
                ofType {
                    kind
                    name
                    ofType {
                        kind
                        name
                        ofType {
                            kind
                            name
                            ofType {
                                kind
                                name
                            }
                        }
                    }
                }
            }
        }
    }
}

资源

Answer 15

您可以使用apollo codegen:client 。 见https://github.com/apollographql/apollo-tooling#apollo-clientcodegen-output