GraphQL Best Practices

12

Documenting your Schema

In this chapter, we will explore the topic of writing documentation for your GraphQL schema. The documentation should be a signpost for both the schema developer and schema consumer, helping the schema to be created and understood and to avoid redundant questions about it.

We have already explored how documentation strings work in GraphQL, but in this chapter, we will try to describe the nodes from the Questions and Answers schema from Chapter 8. By doing so, we will cover the differences between documenting types, interfaces, and input GraphQL nodes.

Also, we will learn how to write additional Markdown documentation, as well as try to guide documentation readers by providing them with root operation descriptions. ...