​​📑 Как документировать GraphQL API: полное руководство для технических писателей

Автор - Денис Ребенок, технический писатель в команде Deckhouse:

"В этой статье разберём:

- что такое GraphQL API и каковы его отличия от REST-like API;
- что такое GraphQL schema и как с ней работать;
- как сделать документацию на GraphQL API красивой и удобной для восприятия;
- как создавать статические справочники для GraphQL API;
- что ещё можно и нужно документировать при документировании GraphQL API.

В конце статьи вы найдёте ссылку на репозиторий на GitHub, который можно скачать, развернуть у себя и использовать, чтобы потренироваться в документировании GraphQL API."

Читать статью