GraphQL-схема — контракт API: какие типы есть, какие у них поля, что клиент может запросить и изменить. Описывают её на языке SDL (Schema Definition Language). В редакторе GraphQL «Помощника SA» схему можно писать и проверять прямо в браузере, без установки программ: ошибки подсвечиваются по мере ввода, а справа строится карта типов.
Как начать
- Откройте песочницу GraphQL — в ней уже открыт пример схемы интернет-магазина с запросами, изменениями, подписками и всеми видами типов.
- Напишите свою схему слева или откройте файл: Файл → Открыть файл…. Подходят файлы .graphql, .gql, .graphqls и .sdl, а также JSON с результатом introspection; файл можно просто перетащить в окно редактора.
- Справа появится карта: карточки типов с полями и стрелки от полей к типам их значений. Щелчок по типу открывает его описание в панели «Описание», двойной щелчок — переводит к определению в коде.
- Чтобы сохранить схему с историей версий, войдите в аккаунт и нажмите Сохранить (или Ctrl/Cmd+S). В песочнице документ хранится в браузере.

Что умеет редактор
- Подсветка и проверка SDL. Ключевые слова, типы, описания и директивы выделены цветом. Ошибки синтаксиса и корректности схемы отмечаются в строке и выводятся под редактором по-русски, с номером строки.
- Переход по типам. С зажатой Ctrl (Cmd на Mac) имя типа в коде становится ссылкой — щелчок переводит к его определению.
- Панель «Описание». Поиск типа или поля, описание выбранного типа: поля с аргументами и значениями по умолчанию, реализуемые интерфейсы, члены объединения, значения перечисления, устаревшие поля с причиной. Кнопки Показать на схеме и Показать в коде находят тип на карте и в тексте.
- Выгрузка. Файл → Скачать: схема в SDL (.graphql), результат introspection (.json), карта схемы в SVG и PNG.
- Пример. Файл → Вставить пример схемы возвращает учебную схему — удобно, чтобы посмотреть, как описываются интерфейсы, объединения, входные типы и пагинация.
Работа в аккаунте
- История версий: каждое сохранение с изменениями создаёт версию, к любой можно вернуться — см. «История версий артефакта».
- Проекты и команда: схему можно добавить в проект и править вместе — «Проекты и совместная работа».
- Ссылка для просмотра: схемой можно поделиться без регистрации получателя — «Как поделиться по ссылке». По этой ссылке карта схемы встраивается в Confluence и MediaWiki виджетом «Помощника SA».
- ИИ-подсказки при вводе и ИИ-ревью схемы по лучшим практикам (тарифы «Макс» и выше).
- API и MCP: схемы доступны ИИ-агентам с той же проверкой синтаксиса — «Как подключить ИИ-агента по MCP».
Что ещё
- Как работать с картой схемы — «Визуализация GraphQL-схемы».
- Схема существующего API из ответа introspection — «Introspection в SDL».
- Синтаксис GraphQL с примерами — документация GraphQL.
Вопросы и ответы
Можно ли писать в редакторе запросы (query, mutation)? Редактор предназначен для схемы. Операции в файле схемы не мешают, но редактор предупредит, что они не входят в схему и на карте не показываются. Синтаксис запросов описан в разделе «Запросы».
Схема разбита на несколько файлов. Объедините их в один документ: части схемы, дополняющие корневые типы, пишутся через extend type Query { … }.
Нужна ли регистрация? Нет: песочница работает без входа, документ хранится в браузере. Аккаунт нужен для истории версий, проектов, ссылок и ИИ-функций.
