Entity references in GraphQL - Mini Project: Build & Apply

Building Entity References in GraphQL

📖 Scenario: You are creating a simple GraphQL API for a library system. The system has books and authors. Each book references an author by ID.

🎯 Goal: Build a GraphQL schema that defines Author and Book types, where each Book references an Author by ID. Then create a query to fetch books with their author details.

📋 What You'll Learn

Define an Author type with fields id and name

Define a Book type with fields id, title, and authorId

Add a query books that returns a list of Book

Add a field author on Book that resolves the author details by authorId

💡 Why This Matters

🌍 Real World

GraphQL schemas with entity references are used in APIs to model relationships between data, like books and authors in a library system.

💼 Career

Understanding entity references in GraphQL is essential for backend developers building APIs that serve connected data efficiently.

1

Define Author and Book types

Create GraphQL types Author with fields id: ID! and name: String!, and Book with fields id: ID!, title: String!, and authorId: ID!.

GraphQL

# Define Author and Book types
# Your code here

Hint

Use type keyword to define GraphQL types. Fields must have types with exclamation marks for required fields.

2

Add books query

Add a Query type with a field books that returns a list of Book (use [Book!]! as the return type).

GraphQL

type Author {
  id: ID!
  name: String!
}

type Book {
  id: ID!
  title: String!
  authorId: ID!
}

# Add Query type with books field
# Your code here

Hint

The Query type is the entry point for queries. Use square brackets for lists and exclamation marks for non-null.

3

Add author field to Book type

Add a field author to the Book type that returns an Author (type Author!). This will be used to fetch the author details for each book.

GraphQL

type Author {
  id: ID!
  name: String!
}

type Book {
  id: ID!
  title: String!
  authorId: ID!
  # Add author field here
}

type Query {
  books: [Book!]!
}

Hint

Add the author field with type Author! inside the Book type.

4

Complete schema with entity references

Combine all previous steps to form the complete GraphQL schema with Author, Book types, the author field on Book, and the books query.

GraphQL

# Review and finalize the complete schema
# Your code here

Hint

Make sure all types and fields from previous steps are included correctly.

Practice

1. What is the main purpose of entity references in GraphQL?

easy

A. To create mutations for updating data

B. To define scalar types like Int and String

C. To connect one type to another and fetch related data

D. To write raw SQL queries inside GraphQL

Solution

1. Step 1: Understand entity references

   Entity references link one GraphQL type to another, allowing related data to be fetched together.

2. Step 2: Compare options

   Only To connect one type to another and fetch related data describes connecting types and fetching related data, which is the purpose of entity references.

3. Final Answer:

   To connect one type to another and fetch related data -> Option C

4. Quick Check:

   Entity references = connect types [OK]

Hint: Entity references link types to get related info fast [OK]

Common Mistakes:

• Confusing entity references with scalar type definitions
• Thinking entity references are for mutations
• Assuming entity references are raw SQL queries

2. Which of the following is the correct way to define an entity reference in a GraphQL schema?

easy

A. type Book { author: Boolean }

B. type Book { author: String }

C. type Book { author: Int }

D. type Book { author: Author }

Solution

1. Step 1: Identify entity reference syntax

   Entity references use another type's name as the field type, e.g., author: Author.

2. Step 2: Check options

   Only type Book { author: Author } uses a type name (Author) as a field type, correctly defining an entity reference.

3. Final Answer:

   type Book { author: Author } -> Option D

4. Quick Check:

   Entity reference = field with another type name [OK]

Hint: Use type names, not scalars, for entity references [OK]

Common Mistakes:

• Using scalar types instead of type names for references
• Confusing field names with types
• Missing curly braces in type definitions

3. Given the schema:

type Author { id: ID! name: String! } type Book { id: ID! title: String! author: Author }

What will the query { book { title author { name } } } return if the book's title is "GraphQL Guide" and the author's name is "Alice"?

medium

A. {"book": {"title": "GraphQL Guide", "author": "Alice"}}

B. {"book": {"title": "GraphQL Guide", "author": {"name": "Alice"}}}

C. {"book": {"title": "GraphQL Guide", "author": null}}

D. SyntaxError

Solution

1. Step 1: Understand the query structure

   The query requests the book's title and the nested author's name, matching the schema's entity reference.

2. Step 2: Predict the output

   The response will include the book title and an object for author with the name field, as in {"book": {"title": "GraphQL Guide", "author": {"name": "Alice"}}}.

3. Final Answer:

   {"book": {"title": "GraphQL Guide", "author": {"name": "Alice"}}} -> Option B

4. Quick Check:

   Nested entity reference returns nested object [OK]

Hint: Nested fields return nested objects, not strings [OK]

Common Mistakes:

• Expecting author as a string instead of an object
• Assuming null author when data exists
• Confusing syntax errors with valid queries

4. Consider this schema snippet:

type Book { id: ID! title: String! author: Author }

and this query:

{ book { title author } }

Why will this query cause an error?

medium

A. Because author is an object type and requires subfields

B. Because title is missing

C. Because book is not defined

D. Because author should be a scalar type

Solution

1. Step 1: Check field types in query

   The author field is an object type, so GraphQL requires specifying which subfields to fetch.

2. Step 2: Identify error cause

   Querying author without subfields causes a validation error, as in Because author is an object type and requires subfields.

3. Final Answer:

   Because author is an object type and requires subfields -> Option A

4. Quick Check:

   Object fields need subfields in queries [OK]

Hint: Always specify subfields for object-type fields [OK]

Common Mistakes:

• Querying object fields without subfields
• Assuming scalar fields need subfields
• Ignoring schema definitions

5. You have these types:

type User { id: ID! name: String! posts: [Post!]! } type Post { id: ID! content: String! author: User! }

How can you write a query to get each user's name and the content of their posts?

hard

A. { user { name posts { content } } }

B. { user { name posts } }

C. { user { posts { content } } }

D. { user { name content } }

Solution

1. Step 1: Understand the schema relations

   User has a list of posts, each post has content. To get user name and posts content, query both fields with nested subfields.

2. Step 2: Check query options

   { user { name posts { content } } } correctly queries user name and nested posts content. Others miss fields or subfields.

3. Final Answer:

   { user { name posts { content } } } -> Option A

4. Quick Check:

   Nested lists need subfields for content [OK]

Hint: Query nested lists with subfields for details [OK]

Common Mistakes:

• Omitting subfields for list items
• Missing user name field
• Trying to query scalar fields as objects