Setting up a GraphQL Server

Setting Up a GraphQL Server

GraphQL is a powerful query language for APIs and a runtime for fulfilling those queries with your existing data. Setting up a GraphQL server with Node.js allows developers to define how clients can interact with the server’s data in a structured and efficient way. In this guide, we will walk through how to set up a basic GraphQL server using Node.js, Express, and the graphql and express-graphql libraries.

1. Prerequisites

• Node.js and npm installed
• Basic knowledge of JavaScript and APIs

2. Initialize the Project

mkdir graphql-server
cd graphql-server
npm init -y

Now install the necessary dependencies:

npm install express graphql express-graphql

3. Creating the Server

Create a file called server.js:

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

// Create schema
const schema = buildSchema(\`
  type Query {
    message: String
  }
\`);

// Define resolver
const root = {
  message: () => 'Hello from GraphQL Server!'
};

const app = express();

app.use('/graphql', graphqlHTTP({
  schema: schema,
  rootValue: root,
  graphiql: true
}));

app.listen(4000, () => {
  console.log('GraphQL server running at http://localhost:4000/graphql');
});

4. Testing the Server

Run your server:

node server.js

Open your browser and navigate to:

http://localhost:4000/graphql

Try the following query in GraphiQL:

{
  message
}

5. Adding Custom Types

Let’s now add a custom type and query that returns a list of users.

Update Schema

const schema = buildSchema(\`
  type User {
    id: ID!
    name: String!
    email: String!
  }

  type Query {
    users: [User]
  }
\`);

Update Resolver

const root = {
  users: () => {
    return [
      { id: '1', name: 'Alice', email: 'alice@example.com' },
      { id: '2', name: 'Bob', email: 'bob@example.com' }
    ];
  }
};

Now restart the server and query:

{
  users {
    id
    name
    email
  }
}

6. Adding Mutations

Mutations allow us to modify server-side data.

Update Schema to Include Mutation

const schema = buildSchema(\`
  type User {
    id: ID!
    name: String!
    email: String!
  }

  type Query {
    users: [User]
  }

  type Mutation {
    addUser(name: String!, email: String!): User
  }
\`);

Update Resolvers

let users = [
  { id: '1', name: 'Alice', email: 'alice@example.com' },
  { id: '2', name: 'Bob', email: 'bob@example.com' }
];

const root = {
  users: () => users,
  addUser: ({ name, email }) => {
    const newUser = {
      id: String(users.length + 1),
      name,
      email
    };
    users.push(newUser);
    return newUser;
  }
};

Example Mutation

mutation {
  addUser(name: "Charlie", email: "charlie@example.com") {
    id
    name
    email
  }
}

7. Error Handling

You can throw errors within resolvers like this:

addUser: ({ name, email }) => {
  if (!name || !email) {
    throw new Error('Name and email are required');
  }
  // continue logic...
}

8. Using GraphQL Playground (Optional)

For a more feature-rich alternative to GraphiQL, you can use GraphQL Playground via the apollo-server-express package.

npm install apollo-server-express

You've now built a basic GraphQL server in Node.js using Express. This setup can be expanded into a full-featured API by integrating databases like MongoDB or PostgreSQL, adding authentication, using GraphQL tools like Apollo, and optimizing performance with dataloaders and caching.