Why schema defines the API contract in GraphQL - See It in Action

Understanding Why Schema Defines the API Contract in GraphQL

📖 Scenario: Imagine you are building a simple online bookstore. You want to create a GraphQL API so that clients can ask for book details in a clear and predictable way.

🎯 Goal: You will create a GraphQL schema that acts as a contract between the client and server. This schema will define exactly what data can be requested and how it is structured.

📋 What You'll Learn

Create a GraphQL schema with a Book type containing id, title, and author fields

Add a Query type with a field book that returns a Book by id

Define the schema as the API contract so clients know what queries are allowed

Use clear and exact names for types and fields as specified

💡 Why This Matters

🌍 Real World

GraphQL schemas are used in real APIs to clearly define what data clients can request and how to ask for it.

💼 Career

Understanding schema as an API contract is essential for backend developers and API designers working with GraphQL.

1

Define the Book type

Create a GraphQL type called Book with fields id of type ID!, title of type String!, and author of type String!.

GraphQL

# Your code here
type Book {
  # Define fields here
}

Need a hint?

Use type Book { ... } and define each field with its type and exclamation mark for required fields.

2

Add the Query type with a book field

Add a Query type with a field called book that takes an argument id of type ID! and returns a Book.

GraphQL

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

# Your code here
type Query {
  # Define book field here
}

Need a hint?

Define type Query { book(id: ID!): Book } so clients can query a book by its ID.

3

Explain the schema as the API contract

Add a comment explaining that this schema defines the API contract by specifying what queries clients can make and what data they will get back.

GraphQL

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

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

# Your comment here explaining the API contract

Need a hint?

Write a clear comment starting with # This schema defines the API contract.

4

Complete the schema with a root schema definition

Add the root schema definition that sets query to Query, completing the schema contract.

GraphQL

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

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

# This schema defines the API contract by specifying exactly what queries are allowed and what data clients will receive.

# Your code here to complete the schema

Need a hint?

Add schema { query: Query } at the end to complete the schema.