Schema definition in GraphQL

Introduction

A schema defines the shape and rules of your data in GraphQL. It tells what data you can ask for and how it is connected.

When you want to describe what data your GraphQL API can provide.

When you need to set rules for what types of data clients can request.

When you want to organize your data into types and fields clearly.

When you want to ensure clients only ask for valid data.

When you want to connect different pieces of data in a structured way.

Syntax

GraphQL

type TypeName {
  fieldName: FieldType
  anotherField: AnotherType
}

schema {
  query: QueryType
  mutation: MutationType
}

type defines a new object type with fields.

The schema block sets the entry points for queries and mutations.

Examples

This defines a Book type with three fields: title, author, and pages.

GraphQL

type Book {
  title: String
  author: String
  pages: Int
}

This defines the Query type with two fields: one to get all books and one to get a book by its ID.

GraphQL

type Query {
  books: [Book]
  book(id: ID!): Book
}

This sets the Query type as the entry point for queries.

GraphQL

schema {
  query: Query
}

Sample Program

This schema defines a User type with id, name, and email fields. It also defines a Query type to get all users or a single user by ID. The schema entry point is set to Query.

GraphQL

type User {
  id: ID!
  name: String
  email: String
}

type Query {
  users: [User]
  user(id: ID!): User
}

schema {
  query: Query
}

Important Notes

Use ! after a type to mark it as required (non-nullable).

Square brackets [] indicate a list of items.

Schema must have at least a query type defined.

Summary

A schema defines the data types and queries your GraphQL API supports.

Use type to create object types with fields.

The schema block sets the main entry points like query and mutation.

Practice

1. What is the purpose of the schema block in a GraphQL schema definition?

easy

A. It specifies the database connection details.

B. It defines the main entry points like query and mutation types.

C. It creates new object types with fields.

D. It lists all the scalar types available.

Solution

1. Step 1: Understand the role of the schema block

   The schema block in GraphQL defines the entry points for the API, such as which types are used for queries and mutations.

2. Step 2: Differentiate from other schema parts

   Object types with fields are defined using type, not the schema block. Database connections and scalar types are not defined here.

3. Final Answer:

   It defines the main entry points like query and mutation types. -> Option B

4. Quick Check:

   Schema block = entry points (query, mutation) [OK]

Hint: Remember schema block sets query and mutation roots [OK]

Common Mistakes:

• Confusing schema block with type definitions
• Thinking schema block defines database details
• Assuming schema block lists scalar types

2. Which of the following is the correct syntax to define a simple object type Book with a title field of type String in GraphQL?

easy

A. schema Book { title: String }

B. object Book { title: String }

C. type Book { title: String }

D. define Book { title: String }

Solution

1. Step 1: Recall GraphQL syntax for object types

   GraphQL uses the keyword type to define object types, followed by the type name and fields inside curly braces.

2. Step 2: Check each option

   Only type Book { title: String } uses the correct keyword type and proper syntax. Others use invalid keywords like object, schema, or define.

3. Final Answer:

   type Book { title: String } -> Option C

4. Quick Check:

   Object type syntax = type + name + fields [OK]

Hint: Use 'type' keyword to define objects in GraphQL [OK]

Common Mistakes:

• Using 'object' or 'define' instead of 'type'
• Confusing schema block with type definition
• Missing curly braces around fields

3. Given the schema definition:

type Query {
  book: Book
}
type Book {
  title: String
  pages: Int
}

What fields can be queried under book?

medium

A. Only title

B. No fields, book is scalar

C. Only pages

D. title and pages

Solution

1. Step 1: Identify the type of book field in Query

   The book field in Query returns a Book object type.

2. Step 2: Check fields inside Book type

   The Book type has two fields: title (String) and pages (Int), so both can be queried.

3. Final Answer:

   title and pages -> Option D

4. Quick Check:

   Object fields = title + pages [OK]

Hint: Object fields are all listed inside its type definition [OK]

Common Mistakes:

• Assuming only one field is accessible
• Thinking book is a scalar, not an object
• Ignoring fields inside the Book type

4. Identify the error in this GraphQL schema snippet:

schema {
  query: Query
}
type Query {
  book: Book
}
type Book {
  title String
}

medium

A. Missing colon ':' after 'title' field name

B. Missing curly braces around Query type

C. Schema block should be named 'type Schema'

D. Book type cannot be used in Query

Solution

1. Step 1: Check field syntax in Book type

   The field title String is missing a colon ':' between the field name and type. It should be title: String.

2. Step 2: Verify other parts of the schema

   The schema block and Query type are correctly defined with proper braces and names.

3. Final Answer:

   Missing colon ':' after 'title' field name -> Option A

4. Quick Check:

   Field syntax requires colon ':' [OK]

Hint: Always put ':' between field name and type [OK]

Common Mistakes:

• Omitting colon ':' after field names
• Confusing schema block syntax
• Misnaming schema block as a type

5. You want to add a mutation to create a new Book with fields title (String) and pages (Int). Which schema definition correctly adds this mutation?

hard

A. type Mutation { createBook(title: String, pages: Int): Book } schema { mutation: Mutation }

B. schema { mutation: Mutation } type Mutation { createBook(title String, pages Int): Book }

C. type Mutation { createBook(title: String, pages: Int): Book } schema { query: Query }

D. type Mutation { createBook(title: String, pages: Int): Book }

Solution

1. Step 1: Define the Mutation type with correct field syntax

   The mutation field createBook must have arguments with colons, e.g., title: String, and return type Book. schema { mutation: Mutation } type Mutation { createBook(title String, pages Int): Book } has missing colons, so it's invalid.

2. Step 2: Link the Mutation type in the schema block

   The schema block must include mutation: Mutation to expose the mutation. type Mutation { createBook(title: String, pages: Int): Book } schema { mutation: Mutation } correctly includes this after defining Mutation.

3. Final Answer:

   type Mutation { createBook(title: String, pages: Int): Book } schema { mutation: Mutation } -> Option A

4. Quick Check:

   Mutation type + schema mutation entry = correct [OK]

Hint: Mutation must be linked in schema block with correct syntax [OK]

Common Mistakes:

• Omitting colons in argument definitions
• Not linking mutation type in schema block
• Only defining mutation type without schema entry