Schema documentation in GraphQL

Introduction

Schema documentation helps explain what each part of your GraphQL schema means. It makes it easier for others to understand and use your API.

When you want to help your team understand the data your API provides.

When you build an API that others will use and need clear instructions.

When you want to keep track of what each field and type in your schema does.

When you want to generate automatic API docs from your schema.

When you want to reduce confusion and mistakes by explaining your schema clearly.

Syntax

GraphQL

"""This is a description"""
type TypeName {
  """Field description"""
  fieldName: FieldType
}

Use triple double quotes """ to add descriptions above types and fields.

Descriptions appear in tools like GraphQL Playground or GraphiQL to help users.

Examples

This example shows how to document a type and its fields.

GraphQL

"""A user in the system"""
type User {
  """Unique ID of the user"""
  id: ID!
  """User's full name"""
  name: String
}

Here, the query and its field are documented to explain their purpose.

GraphQL

"""Query root"""
type Query {
  """Get a user by ID"""
  user(id: ID!): User
}

Sample Program

This schema documents the Query type and the Book type with descriptions for each field.

GraphQL

"""Root query type"""
type Query {
  """Fetch a book by its ID"""
  book(id: ID!): Book
}

"""A book object"""
type Book {
  """Unique identifier for the book"""
  id: ID!
  """Title of the book"""
  title: String!
  """Author of the book"""
  author: String
}

Important Notes

Descriptions should be clear and concise to help users quickly understand the schema.

Use documentation to improve collaboration and reduce errors when using the API.

Summary

Schema documentation uses triple quotes to add descriptions.

It helps users understand the API without guessing.

Good documentation improves teamwork and API usability.

Practice

1. What is the purpose of using triple quotes """ in GraphQL schema documentation?

easy

A. To define a new type in the schema

B. To write comments that are ignored by the server

C. To add descriptions to types and fields

D. To create a mutation operation

Solution

1. Step 1: Understand triple quotes usage in GraphQL

   Triple quotes """ are used to add descriptions to schema elements like types and fields.

2. Step 2: Differentiate from other schema elements

   They are not for defining types, comments, or mutations but for documentation purposes.

3. Final Answer:

   To add descriptions to types and fields -> Option C

4. Quick Check:

   Triple quotes = descriptions [OK]

Hint: Triple quotes always mean description text in GraphQL [OK]

Common Mistakes:

• Confusing triple quotes with comments
• Thinking triple quotes define types
• Using triple quotes for operations

2. Which of the following is the correct way to add a description to a GraphQL field named age?

easy

A. """User age""" age: Int

B. age: Int # User age

C. age: Int """User age"""

D. "User age" age: Int

Solution

1. Step 1: Identify correct syntax for field description

   In GraphQL, descriptions go before the field using triple quotes.

2. Step 2: Check each option

   """User age""" age: Int places """User age""" before age: Int, which is correct syntax.

3. Final Answer:

   """User age""" age: Int -> Option A

4. Quick Check:

   Description before field with triple quotes = correct [OK]

Hint: Put triple-quoted description right before the field [OK]

Common Mistakes:

• Placing description after the field
• Using single quotes instead of triple quotes
• Using comments (#) instead of descriptions

3. Given this schema snippet, what will the description of the name field be?

type Person {
  """Full name of the person"""
  name: String
  age: Int
}

medium

A. Full name of the person

B. Name of the person

C. No description

D. Person's age

Solution

1. Step 1: Locate the description for the name field

   The triple-quoted string """Full name of the person""" is right above name: String.

2. Step 2: Understand it applies as the description

   This means the description for the name field is exactly that string.

3. Final Answer:

   Full name of the person -> Option A

4. Quick Check:

   Description above field = "Full name of the person" [OK]

Hint: Description above field is the field's doc [OK]

Common Mistakes:

• Assuming no description if not inline
• Confusing field name with description
• Mixing descriptions of different fields

4. Identify the error in this schema documentation snippet:

type Query {
  """Fetch user by ID"""
  user(id: ID!): User
  """Fetch all users"""
  users: [User]
  "Fetch version info"
  version: String
}

medium

A. Descriptions must be after the field, not before

B. The description for version uses double quotes instead of triple quotes

C. Descriptions cannot be used on Query type fields

D. The id argument is missing a description

Solution

1. Step 1: Check description syntax for each field

   The first two fields use triple quotes correctly. The version field uses double quotes "Fetch version info", which is invalid.

2. Step 2: Confirm correct usage

   Descriptions must use triple quotes """ to be valid in GraphQL schema.

3. Final Answer:

   The description for version uses double quotes instead of triple quotes -> Option B

4. Quick Check:

   Descriptions need triple quotes, not double [OK]

Hint: Descriptions always need triple quotes, not double [OK]

Common Mistakes:

• Using single or double quotes instead of triple quotes
• Placing descriptions after fields
• Assuming arguments need descriptions

5. You want to document a GraphQL schema so that the Book type and its title field have clear descriptions. Which schema snippet correctly documents both?

hard

A. "A book in the library" type Book { title: String "Title of the book" }

B. type Book { title: String """Title of the book""" } """A book in the library"""

C. type Book { "A book in the library" title: String "Title of the book" }

D. """A book in the library""" type Book { """Title of the book""" title: String }

Solution

1. Step 1: Check how to document a type

   The type description must be placed immediately before the type keyword using triple quotes.

2. Step 2: Check how to document a field

   The field description must be placed immediately before the field definition using triple quotes.

3. Step 3: Validate each option

   Only """A book in the library""" type Book { """Title of the book""" title: String } correctly places triple-quoted descriptions before the type and field.

4. Final Answer:

   """A book in the library""" type Book { """Title of the book""" title: String } -> Option D

5. Quick Check:

   Descriptions before type and field with triple quotes = correct [OK]

Hint: Put triple-quoted descriptions right before type and field [OK]

Common Mistakes:

• Placing descriptions after types or fields
• Using single quotes instead of triple quotes
• Not adding description for both type and field