Форматиращ инструмент за 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 на форматиращия инструмент за код.