Node interface pattern in GraphQL

Introduction

The Node interface pattern helps us fetch any object by its unique ID in a simple way.

When you want to get different types of data (like users, posts, or comments) using one query.

When building apps that need to load data quickly by ID.

When you want a consistent way to fetch any item in your system.

When you want to make your API easier to use and understand.

When you want to support pagination and caching efficiently.

Syntax

GraphQL

interface Node {
  id: ID!
}

type User implements Node {
  id: ID!
  name: String!
}

type Post implements Node {
  id: ID!
  title: String!
}

# Query to fetch any Node by id
 type Query {
  node(id: ID!): Node
}

The Node interface requires an id field that is unique.

Types like User and Post implement Node to share this ID field.

Examples

This defines the Node interface with a required unique ID.

GraphQL

interface Node {
  id: ID!
}

User type implements Node and adds a name field.

GraphQL

type User implements Node {
  id: ID!
  name: String!
}

Query to get any Node by its ID.

GraphQL

type Query {
  node(id: ID!): Node
}

Sample Program

This example shows the Node interface with User and Post types. The query fetches a node by ID and uses fragments to get fields based on the actual type.

GraphQL

interface Node {
  id: ID!
}

type User implements Node {
  id: ID!
  name: String!
}

type Post implements Node {
  id: ID!
  title: String!
}

type Query {
  node(id: ID!): Node
}

# Sample query
# {
#   node(id: "1") {
#     id
#     ... on User {
#       name
#     }
#     ... on Post {
#       title
#     }
#   }
# }

# Sample response for node with id "1" being a User
# {
#   "data": {
#     "node": {
#       "id": "1",
#       "name": "Alice"
#     }
#   }
# }

Important Notes

Use fragments (... on TypeName) to get fields specific to each type.

The id field must be unique across all types implementing Node.

This pattern helps clients fetch any object with one query, simplifying API design.

Summary

The Node interface defines a unique ID for all types.

It allows fetching any object by ID using one query.

Use fragments to get type-specific fields when querying a Node.

Practice

1. What is the main purpose of the Node interface in GraphQL?

easy

A. To provide a unique ID for all object types

B. To define custom mutations for each type

C. To restrict queries to only one type

D. To automatically generate database schemas

Solution

1. Step 1: Understand the Node interface role

   The Node interface is designed to give every object type a unique identifier.

2. Step 2: Identify its main use

   This unique ID allows fetching any object by ID in a single query.

3. Final Answer:

   To provide a unique ID for all object types -> Option A

4. Quick Check:

   Node interface = unique ID for all types [OK]

Hint: Node interface always provides unique IDs for all types [OK]

Common Mistakes:

• Thinking Node defines mutations
• Believing Node restricts queries to one type
• Assuming Node auto-generates database schemas

2. Which of the following is the correct way to declare the Node interface in GraphQL SDL?

easy

A. interface Node { id: Boolean! }

B. interface Node { id: String }

C. interface Node { id: Int! }

D. interface Node { id: ID! }

Solution

1. Step 1: Recall the Node interface ID type

   The Node interface requires an id field of type ID!, which is a non-null unique identifier.

2. Step 2: Check each option's ID type

   interface Node { id: ID! } uses ID!, which is correct. Others use wrong types like String, Int, or Boolean.

3. Final Answer:

   interface Node { id: ID! } -> Option D

4. Quick Check:

   ID field in Node = ID! type [OK]

Hint: Node interface ID must be non-null ID type [OK]

Common Mistakes:

• Using String or Int instead of ID type
• Making ID nullable (missing !)
• Using Boolean as ID type

3. Given this query using the Node interface:

query { node(id: "123") { id ... on User { name } ... on Post { title } } }

What fields will be returned if the node with ID "123" is a Post?

medium

A. { "id": "123", "name": "Alice" }

B. { "id": "123", "title": "GraphQL Basics" }

C. { "id": "123" }

D. Error: Cannot query fragment on Post

Solution

1. Step 1: Understand the query structure

   The query fetches a node by ID and requests the id field plus fragments for User and Post types.

2. Step 2: Determine the node type and returned fields

   If the node is a Post, the title field from the Post fragment is returned along with id. The User fragment is ignored.

3. Final Answer:

   { "id": "123", "title": "GraphQL Basics" } -> Option B

4. Quick Check:

   Node query returns fields for actual type fragment [OK]

Hint: Fragments return fields only for matching node type [OK]

Common Mistakes:

• Expecting fields from non-matching fragments
• Ignoring the id field
• Assuming query causes error

4. You wrote this schema snippet:

interface Node { id: ID! }
type User implements Node { id: ID name: String }

Why will this schema cause an error?

medium

A. User's id field must be non-null (ID!) to match Node interface

B. User type cannot implement Node interface

C. id field type must be String, not ID

D. User type must not have extra fields like name

Solution

1. Step 1: Compare interface and type field definitions

   The Node interface requires id as ID! (non-null). The User type declares id as ID (nullable).

2. Step 2: Understand GraphQL type compatibility rules

   Implementing types must match or be more strict. Here, User's id is less strict (nullable), causing an error.

3. Final Answer:

   User's id field must be non-null (ID!) to match Node interface -> Option A

4. Quick Check:

   Implementing type fields must match interface exactly [OK]

Hint: Implementing type fields must be equal or stricter than interface [OK]

Common Mistakes:

• Thinking User can't implement Node
• Changing id type to String
• Removing extra fields like name

5. You want to fetch a list of mixed objects (Users and Posts) by their IDs using the Node interface. Which approach correctly fetches their specific fields in one query?

hard

A. Use a union type instead of Node interface

B. Query Users and Posts separately with two queries

C. Use a nodes(ids: [ID!]!) query returning [Node], then use inline fragments for User and Post fields

D. Fetch only the id field without fragments

Solution

1. Step 1: Understand Node interface usage for mixed types

   The Node interface allows fetching any object by ID in one query, returning a list of Nodes.

2. Step 2: Use inline fragments to get type-specific fields

   To get fields specific to Users and Posts, use inline fragments ... on User and ... on Post inside the query.

3. Final Answer:

   Use a nodes(ids: [ID!]!) query returning [Node], then use inline fragments for User and Post fields -> Option C

4. Quick Check:

   Node interface + fragments fetch mixed types in one query [OK]

Hint: Use nodes query with fragments for mixed type fields [OK]

Common Mistakes:

• Querying types separately instead of one query
• Using union instead of interface for this pattern
• Fetching only id without needed fields