Why schema defines the API contract in GraphQL - Quick Recap

Recall & Review

beginner

What is a schema in GraphQL?

A schema in GraphQL is a blueprint that defines the types of data you can query or mutate, and how clients can interact with the API.

beginner

Why is the schema called the API contract?

Because it clearly states what data and operations are available, how to request them, and what to expect in return, ensuring both client and server agree on communication.

intermediate

How does a schema help prevent errors in API communication?

It enforces rules on what queries are valid and what data types are expected, so clients cannot ask for data that doesn't exist or send wrong data formats.

intermediate

What role does the schema play in API evolution?

The schema allows safe changes by clearly defining what is supported, so clients can adapt without breaking when new fields or types are added.

beginner

How does the schema improve developer experience?

It provides clear documentation and auto-completion in tools, making it easier and faster for developers to understand and use the API correctly.

What does the GraphQL schema define?

A The network protocol for communication

B The database engine used by the server

C The client-side UI layout

D The structure and types of data clients can request

The schema defines the data types and operations available in the API, not the database engine or UI.

Why is the schema called an API contract?

A It manages server hardware resources

B It controls user authentication

C It sets rules for data exchange between client and server

D It designs the client application

The schema acts as a contract by defining what data and operations are allowed, ensuring both sides agree.

How does the schema help avoid client errors?

A By validating queries against defined types and fields

B By encrypting data in transit

C By limiting the number of users

D By caching responses

The schema validates queries so clients cannot request invalid data or use wrong types.

What benefit does schema provide during API updates?

A It automatically updates client software

B It allows adding new fields without breaking existing clients

C It deletes old data automatically

D It changes the database schema

The schema helps evolve the API safely by defining what is supported, so clients can adapt gradually.

How does the schema improve developer experience?

A By providing clear documentation and tooling support

B By increasing server speed

C By reducing network latency

D By managing user permissions

The schema offers clear docs and enables tools like auto-completion, helping developers use the API easily.

Explain why the GraphQL schema is considered the API contract.

Think about how the schema acts like a promise between client and server.

Describe how the schema helps developers when using or updating an API.

Consider how the schema supports both learning and maintaining the API.

Practice

1. What is the main purpose of a GraphQL schema in an API?

easy

A. To define the types of data and queries the API supports

B. To store user data permanently

C. To style the API responses with colors

D. To encrypt the data sent over the network

Solution

1. Step 1: Understand what a schema represents

   A GraphQL schema acts like a menu that lists what data and operations are available in the API.

2. Step 2: Identify the schema's role in API communication

   It defines the types and queries so clients know exactly what they can ask for and expect.

3. Final Answer:

   To define the types of data and queries the API supports -> Option A

4. Quick Check:

   Schema = API contract [OK]

Hint: Schema is the API's menu of data and queries [OK]

Common Mistakes:

• Thinking schema stores data permanently
• Confusing schema with styling or encryption
• Believing schema handles data encryption

2. Which of the following is the correct way to define a simple GraphQL schema type for a User with an id and name?

easy

A. type User { id: Int name: String }

B. type User { id: Int, name: String }

C. type User { id Int, name String }

D. type User (id: Int, name: String)

Solution

1. Step 1: Recall GraphQL type syntax

   Fields inside a type are defined with a name, colon, then type, separated by commas or new lines.

2. Step 2: Check each option's syntax

   type User { id: Int, name: String } correctly uses colons and commas to separate fields: id: Int, name: String.

3. Final Answer:

   type User { id: Int, name: String } -> Option B

4. Quick Check:

   Correct field syntax = type User { id: Int, name: String } [OK]

Hint: Use colon between field and type, commas optional but clearer [OK]

Common Mistakes:

• Omitting colons between field and type
• Using parentheses instead of braces
• Missing commas causing syntax errors

3. Given this schema snippet:

type Query { user(id: Int): User }

What will happen if a client queries for { user(id: 1) { id name } } but the schema does not define the name field on User?

medium

A. The query will return an error about the unknown field 'name'

B. The query will return the user with an empty 'name' field

C. The query will ignore the 'name' field and return only 'id'

D. The query will return null for the entire user

Solution

1. Step 1: Understand schema validation

   GraphQL validates queries against the schema. If a field is not defined, it causes an error.

2. Step 2: Apply to the given query

   The 'name' field is missing in the User type, so the query asking for it will fail with an error.

3. Final Answer:

   The query will return an error about the unknown field 'name' -> Option A

4. Quick Check:

   Query fields must exist in schema [OK]

Hint: Query fields must match schema exactly [OK]

Common Mistakes:

• Assuming missing fields return empty or null silently
• Thinking GraphQL ignores unknown fields
• Believing partial data is returned without error

4. You wrote this schema:

type Query { getUser(id: Int): User }

But your API returns an error when querying { getUser(id: 5) { id name } }. What is the likely mistake?

medium

A. The Query type must be named 'query' in lowercase

B. The query syntax is invalid because of missing commas

C. The argument 'id' should be non-nullable with an exclamation mark

D. The User type is not defined or missing fields

Solution

1. Step 1: Check schema completeness

   The Query type is correctly named with uppercase 'Query', which is standard in GraphQL.

2. Step 2: Consider User type definition

   If the User type is missing or lacks requested fields like 'id' or 'name', the query will error.

3. Final Answer:

   The User type is not defined or missing fields -> Option D

4. Quick Check:

   Missing type or fields cause query errors [OK]

Hint: Check if all types and fields exist in schema [OK]

Common Mistakes:

• Thinking Query must be lowercase
• Assuming nullable arguments cause errors
• Blaming query syntax when schema is incomplete

5. You want to extend your GraphQL API to include a new type Book with fields id, title, and author. How does defining this in the schema help your API users?

hard

A. It hides the Book type from users to keep it private

B. It automatically fills the database with book data

C. It tells users exactly what data they can request and how to ask for it

D. It encrypts the Book data before sending it

Solution

1. Step 1: Understand schema role in API design

   Defining a new type in the schema acts like adding a new menu item, showing users what data is available.

2. Step 2: Explain benefit to API users

   This helps users know what fields exist and how to write queries to get that data without errors.

3. Final Answer:

   It tells users exactly what data they can request and how to ask for it -> Option C

4. Quick Check:

   Schema defines API contract for users [OK]

Hint: Schema shows users what data and queries exist [OK]

Common Mistakes:

• Thinking schema fills or encrypts data
• Believing schema hides types from users
• Confusing schema with database content