GraphQLJS use a .graphql file for a query from nodejs

Question

I have created a basic GraphQL Express app and I'm wanting to bundle pre defined data from pre defined queries with specific routes.

Ideally the query should allow providing arguments so it can be used flexibly, I would like to be able to save the query to a file and run it on demand but provide arguments specific to the current data required.

I can query the api with the following query

query authors(ids: [1337, 42]) {
  name,
  id
}

The query.graphql file should be something like the following:

getAuthorsById($ids: Int[]) {
  authors(ids: $ids) {
    name,
    id
  }
}

What I want to do within the Node server is get the content from a query.graphql file and execute it when a specific route is fired eg.

const query = somehowImportTheQuery('./query.graphql')
graphql(schema, query([1337, 42]))

The above code somehowImportTheQuery should import the query and return a function getAuthorsById that can be called with arguments.

Does something like this already exist? or are there any tools or documentation that can help me achieve the desired functionality?

Thanks for any help!

Lin Du · Accepted Answer · 2020-09-10 09:01:58Z

4

You could use documents-loading of graphql-tools module to load GraphQL operation documents from different sources.

E.g.

index.ts:

import { GraphQLSchema, buildSchema, graphql } from 'graphql';
import { loadDocumentsSync, GraphQLFileLoader } from 'graphql-tools';
import path from 'path';

const typeDefs: string = `
    type Author {
        id: ID!
        name: String
    }
    type Query {
        authors(ids: [ID]!): [Author]!
    }
`;
const resolvers = {
  authors({ ids }) {
    return [
      { id: ids[0], name: 'a' },
      { id: ids[1], name: 'b' },
    ];
  },
};

const schema: GraphQLSchema = buildSchema(typeDefs);

const query = loadDocumentsSync(path.resolve(__dirname, './query.graphql'), {
  loaders: [new GraphQLFileLoader()],
});

graphql({
  schema,
  source: query[0].rawSDL!,
  rootValue: resolvers,
  variableValues: { ids: [1337, 42] },
}).then(({ data }) => {
  console.log(data);
});

query.graphql:

query getAuthorsById($ids: [ID]!) {
  authors(ids: $ids) {
    name
    id
  }
}

The execution result:

[Object: null prototype] {
  authors:
   [ [Object: null prototype] { name: 'a', id: '1337' },
     [Object: null prototype] { name: 'b', id: '42' } ] }

answered Sep 10, 2020 at 9:01

Lin Du

104k138 gold badges340 silver badges575 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

synthet1c Over a year ago

Thanks for the great answer, that's perfect. I already made a basic file loader but it's probably best to use the graphql-tools like you have suggested.

Timo Over a year ago

I want to fetch data from github graphql api with a file query.graphql that is nicely formatted, so where is the fetch to send the query as post data and then fetch the result of the query?

Collectives™ on Stack Overflow

GraphQLJS use a .graphql file for a query from nodejs

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related