How to return a json string as response in GraphQL

Question

Im pretty new graphQL. My requirement is when sending a query, graphQL should return a JSON response as below

{
    user: '$',
    name: 'Josh',
    age: '30'
}

I tried in following way but not achieved the result.

var express = require('express');
var graphqlHTTP = require('express-graphql');
var { buildSchema } = require('graphql');

var schema = buildSchema(`
  type Query {
    user: String!
  }
`);


// JSON
var json = {
    user: '$',
    name: 'Josh',
    age: '30'
};

var root = {
    user: () => {
      return json;
    }
};

var app = express();
app.use('/graphql', graphqlHTTP({
  schema: schema,
  rootValue: root,
  graphiql: true,
}));
app.listen(4000);
console.log('Running a GraphQL API server at localhost:4000/graphql');

Can someone guide where I'm going wrong.

Thanks in advance.

In GraphQL you want to create types for all your returned JSON objects. In your case you should not return String for user but probably an object of type User and then define the user type: type User { user: String! name: String! age: String! }. Consider converting age to Int. — Herku
– Herku, Commented Oct 11, 2019 at 13:46

Brian Burns · Accepted Answer · 2021-01-19 11:41:38Z

6

I implemented in the following method:

var express = require('express');
var graphqlHTTP = require('express-graphql');
var { buildSchema } = require('graphql');
const { GraphQLJSON, GraphQLJSONObject } = require('graphql-type-json');

var schema = buildSchema(`
  scalar JSON
  type Query {
    getObject: JSON
  }
`);

var root = {
    JSON: GraphQLJSON,
    
    getObject: () => {
      return {
        name: "jshua",
        age: "30",
        place: "china",
        gender: "Male"
      }
    }
    
};

var app = express();
app.use('/graphql', graphqlHTTP({
  schema: schema,
  rootValue: root,
  graphiql: true,
}));
app.listen(4000);
console.log('Running a GraphQL API server at localhost:4000/graphql');

See https://github.com/taion/graphql-type-json

edited Jan 19, 2021 at 11:41

Brian Burns

22.4k10 gold badges93 silver badges80 bronze badges

answered Oct 14, 2019 at 6:35

suji

1,4706 gold badges22 silver badges41 bronze badges

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

Collectives™ on Stack Overflow

How to return a json string as response in GraphQL

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related