Documenting and Exploring Your Schema
Make your GraphQL API approachable: write good schema documentation, leverage introspection, and use GraphiQL so developers can discover and try your API with ease.
The Schema Is the Documentation
One of GraphQL's superpowers is that the schema is strongly typed and self-describing. With a little care, your schema becomes living documentation that never drifts from reality.
Describing Types and Fields
Add a description by writing a string literal directly above any type or field in the SDL. Tools surface these as inline docs.
type Book {
"The book's unique identifier"
id: ID!
"Full title as printed on the cover"
title: String!
}All lessons in this course
- API Versioning Strategies
- GraphQL Client Libraries
- Future of GraphQL with Spring
- Documenting and Exploring Your Schema