Export of GraphQL Schema

[Bilal-S]

Is there anyway to export the graphQL schema that is being generated?
I would like to go beyond the introspection cache and be able to use the schema independently?

Appreciate any feedback.

[dotansimha]

Hi @Bilal-S !
Are you referring to the executable schema (GraphQLSchema), or to the SDL only?

If you wish to get the GraphQLSchema instance, follow this: https://www.graphql-mesh.com/docs/getting-started/basic-example and use getMesh to get the executable schema.

If you wish to get the JSON introspection of the schema, you can use dump-schema command, like that: yarn graphql-mesh dump-schema --output ./schema.json (note, if you'll set the extension to .graphql, you'll get SDL ;) )

[Bilal-S]

yarn graphql-mesh dump-schema --output ./schema.graphql
works
Thank you.

[Bilal-S]

@dotansimha
I ran a test and the output does not look like portable SDL (Schema Definition Language (SDL) ).

Here the example:

{
  "__schema": {
    "description": null,
    "queryType": {
      "name": "Query"
    },
    "mutationType": {
      "name": "Mutation"
    },
    "subscriptionType": null,
    "types": [
      {
        "kind": "OBJECT",
        "name": "Query",
        "description": null,
        "specifiedByUrl": null,
        "fields": [

...

While I was looking for something like SDL:
https://graphql.org/learn/schema/

Is there anyway to covert this?

[Urigo]

@Bilal-S do you think there is something we could do to improve the docs to make it easier for others who wish to do the same?

[santino]

Actually, I think so.
I believe we should have a dedicated entry in the docs for the cli that lists and describe all the commands available.
This can sit alongside the pages we have already for handlers and transformers.

[Bilal-S]

It was not clear to me that the output filename and extension makes a difference and they were used as implicit flags. Thus the cli makes decisions based on file name extension. This was not described or I could not find it.

I also agree with @santino, all commands for CLI should be described with examples. If there are implicit decisions that the CLI makes, then, a line on that could be added for clarification.

Things that I thought would be interesting but could not find good examples:

• how to combine graphql-mesh and Appollo server, e.g. create a custom datasource to exploe gql-mesh?
• a security concept around graphql-mesh: role based, context, etc.

[Urigo]

@Bilal-S would you be open to create a PR to our docs?
We will support and help you

[Bilal-S]

Ok. Be glad to pitch in. But, it will be a bit.