get-graphql-schema#

The GraphQL schema language is a concise way to represent the available schema provided by a GraphQL endpoint. It looks something like this:

1
type assets {
2
  url: String
3
  node_id: String
4
  name: String
5
  label: String
6
  content_type: String
7
  state: String
8
  created_at: String
9
  updated_at: String
10
  browser_download_url: String
11
  id: Int
12
  size: Int
13
  download_count: Int
14
  uploader: users
15
  release: releases
16
}
17

18
type assetsCollection {
19
  totalCount: Int
20
  pageInfo: PageInfo
21
  nodes: [assets]
22
  edges: [assetsEdge]
23
}

You can retrieve a JSON version of this from the GraphQL server itself using the query at the bottom of this document.

But… if you want it back in readable text as shown above, you can use the get-graphql-schema tool. Run that like this:

1
npx get-graphql-schema https://github-to-sqlite.dogsheep.net/graphql

If the API requires authentication, use the --header option like this:

1
npx get-graphql-schema https://api.github.com/graphql -h 'Authorization=Bearer XXX'

Retrieving the schema as JSON using GraphQL#

I found this query using the network inspector against a GraphiQL instance (https://api.fly.io/graphql) that offered a “Schema” tab:

1
query IntrospectionQuery {
2
  __schema {
3
    queryType {
4
      name
5
    }
6
    mutationType {
7
      name
8
    }
9
    subscriptionType {
10
      name
11
    }
12
    types {
13
      ...FullType
14
    }
15
    directives {
16
      name
17
      description
18
      locations
19
      args {
20
        ...InputValue
21
      }
22
    }
23
  }
24
}
25
fragment FullType on __Type {
26
  kind
27
  name
28
  description
29
  fields(includeDeprecated: true) {
30
    name
31
    description
32
    args {
33
      ...InputValue
34
    }
35
    type {
36
      ...TypeRef
37
    }
38
    isDeprecated
39
    deprecationReason
40
  }
41
  inputFields {
42
    ...InputValue
43
  }
44
  interfaces {
45
    ...TypeRef
46
  }
47
  enumValues(includeDeprecated: true) {
48
    name
49
    description
50
    isDeprecated
51
    deprecationReason
52
  }
53
  possibleTypes {
54
    ...TypeRef
55
  }
56
}
57
fragment InputValue on __InputValue {
58
  name
59
  description
60
  type {
61
    ...TypeRef
62
  }
63
  defaultValue
64
}
65
fragment TypeRef on __Type {
66
  kind
67
  name
68
  ofType {
69
    kind
70
    name
71
    ofType {
72
      kind
73
      name
74
      ofType {
75
        kind
76
        name
77
        ofType {
78
          kind
79
          name
80
          ofType {
81
            kind
82
            name
83
            ofType {
84
              kind
85
              name
86
              ofType {
87
                kind
88
                name
89
              }
90
            }
91
          }
92
        }
93
      }
94
    }
95
  }
96
}

Newsletter

get-graphql-schema#

Retrieving the schema as JSON using GraphQL#