Introduction to GraphQL

Introduction to GraphQL

GraphQL is a query language and runtime for APIs developed by Facebook in 2012 and released publicly in 2015. It provides a more efficient, powerful, and flexible alternative to REST by allowing clients to request exactly the data they need and nothing more.

1. What is GraphQL?

GraphQL allows clients to define the structure of the response. It solves many of the shortcomings of REST, such as over-fetching or under-fetching of data, and provides a strongly typed schema that serves as a contract between client and server.

Key Features

• Declarative data fetching
• Single endpoint
• Real-time support via subscriptions
• Strongly typed schema
• Efficient and flexible queries

2. Setting Up a GraphQL Server in Node.js

Step 1: Initialize the Project

mkdir graphql-api
cd graphql-api
npm init -y
npm install express express-graphql graphql

Step 2: Basic Server Setup

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

const schema = buildSchema(`
  type Query {
    hello: String
  }
`);

const root = {
  hello: () => 'Hello, GraphQL!'
};

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

app.listen(4000, () => console.log('Server running on http://localhost:4000/graphql'));

3. GraphQL Schema

A GraphQL schema defines types, queries, mutations, and subscriptions. It's the backbone of any GraphQL server.

Example Schema

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

  type Query {
    getUser(id: ID!): User
    getUsers: [User]
  }

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

4. Resolvers

Resolvers are functions that handle the logic for returning data for each field in the schema.

let users = [
  { id: '1', name: 'John Doe', email: 'john@example.com' }
];

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

5. Querying GraphQL

With GraphiQL enabled, navigate to http://localhost:4000/graphql  and try the following:

Query Example

{
  getUser(id: "1") {
    name
    email
  }
}

Mutation Example

mutation {
  addUser(name: "Jane Doe", email: "jane@example.com") {
    id
    name
    email
  }
}

6. GraphQL vs REST

7. Tooling & Ecosystem

• GraphiQL – In-browser IDE for exploring GraphQL APIs
• Apollo Server/Client – Popular GraphQL server/client for JavaScript
• Relay – GraphQL client maintained by Facebook
• Hasura – Instant GraphQL APIs over PostgreSQL

8. Advanced Concepts

8.1. GraphQL Subscriptions

Allows real-time communication using WebSockets.

8.2. Input Types

input UserInput {
  name: String!
  email: String!
}

type Mutation {
  addUser(input: UserInput): User
}

8.3. Interfaces and Unions

interface Animal {
  name: String!
}

type Dog implements Animal {
  name: String!
  breed: String!
}

union SearchResult = User | Dog

GraphQL represents a modern approach to API design that gives clients more power, improves performance, and simplifies server logic. With Node.js, tools like express-graphql and Apollo Server make it easy to get started and scale your GraphQL APIs effectively.