Форматувач GraphQL
Форматуйте запити, мутації, фрагменти та схеми GraphQL за допомогою цього форматувача GraphQL. Вставте документ — інструмент розбере його за допомогою парсера GraphQL та виведе у стандартному форматі: відступи у два пробіли, одне поле в рядку, без ком між полями та з однаковими пробілами навколо аргументів і змінних. Про синтаксичні помилки буде повідомлено, тож розробники API отримають читабельні операції та SDL для документації, перевірки й налагодження.
Поширені запитання
Як працює форматувач GraphQL?
Він розбирає документ у синтаксичне дерево GraphQL і виводить його у стандартному форматі. Оскільки документ розбирається, некоректний GraphQL відхиляється, а не переформатовується неправильно.
Що можна форматувати?
Запити, мутації, підписки та фрагменти, а також визначення схеми у SDL, як-от блоки type, input, enum, interface, union і schema. В одному документі можна поєднувати кілька визначень.
Який вигляд має результат?
Кожен набір вибірок має відступ у два пробіли й одне поле в рядку, а коми між полями видаляються. Після кожної двокрапки в аргументах і визначеннях змінних додається пробіл, наприклад user(id: $id).
Що станеться в разі синтаксичної помилки?
Інструмент зупиняється та показує повідомлення парсера, наприклад Syntax Error: Expected Name, found }. Виправте вказане місце та запустіть форматування знову.
Коментарі зберігаються?
Форматувальник зберігає коментарі з решіткою (#) там, де парсер може їх прив’язати, наприклад після закривної фігурної дужки. Описи в лапках для типів і полів схеми є частиною документа й завжди зберігаються.
Чи перевіряє інструмент мій запит за схемою?
Ні, він перевіряє лише синтаксис. Наявність полів і аргументів визначається схемою вашого сервера, тому для перевірки скористайтеся клієнтом або сервером GraphQL.
Чи можна форматувати рядок запиту, скопійований з JavaScript?
Вставте лише документ GraphQL, без лапок, зворотних лапок або тегу gql навколо нього. Екрановані символи з даних JSON спочатку потрібно розекранувати.
Чи можна змінити відступи?
Ні, форматувач завжди використовує два пробіли й не має параметрів. Такий формат використовують більшість інструментів і документації GraphQL.
Чому результат обрамлено блоком коду graphql?
Результат повертається як блок коду Markdown із позначкою graphql, тому в Markdown він відображається з підсвічуванням синтаксису. Скопіюйте рядки між огорожами у файл .graphql.
Якого максимального розміру може бути документ?
До 5 MB за один запуск; більший вхідний текст відхиляється з повідомленням. Результат ідентичний варіанту GraphQL у форматувачі коду.