22 мая 2025 на встрече Moscow QA № 13 рассказала о том, как составляется запрос в GraphQL API «ручками». Чтобы понимать, как система типа Apollo делает это «под капотом» =)
Тестовая система для «потыкать GraphQL самому» — https://testbase.atlassian.net/wiki/spaces/GraphQL/pages/4427939842/Cards
Чтобы понимать, какие запросы можно отправлять в GraphQL API и что можно получить в ответе, нужно уметь читать его схему. Это как WSDL в SOAP API — описание всех доступных методов.
Да, программы типа Postman или Apollo сами считывают схему и показывают вам всё в красивом виде — просто ходи да «натыкивай» запросы. Но если само API ещё в разработке, чтение схемы поможет понять, что вас ожидает.
Поэтому в этой статье я расскажу, что такое Schema GraphQL API и как её читать.
Если открыть GraphQL API в Apollo Studio, мы увидим документацию по методам. Посмотрим на примере системы Cards, ссылка в Apollo — https://cards.bugred.ru/online.
Чтобы документация появилась, нужно вызвать первый запрос с авторизацией — система защищена, без заголовка Authorization ничего не вернет (пароль см в документации по ссылке выше). Можно послать универсальный запрос: query UniversalQuery { __typename}
И вот мы видим, какие вообще методы нам доступны. Посмотрим на запросы Query:
Зайдем в любой метод, например, в метод getUser. И смотрите, у возвращаемого объекта есть описание на русском! «Тип данных пользователь»:
В GraphQL для поля любого объекта вы можете указать аргументы. А объект — это который определяется через ключевое слово type:
Однако обычно аргументы используют в запросах — query и mutation (это тоже объекты в схеме). Там всё логично:
Вот, допустим, решили мы поиграться с GraphQL системой Cards. Открыли Apollo и накликали запрос:
Потом накликали другой, третий... В общем, первый запрос стерли. Но тут решили вернуться к нему (например, делали ДЗ на курсе и нужно подправить запрос по комментарию тренера), а как? Запроса то больше нету 😨
Тут есть пользователи и их банковские карты. Можно пополнить баланс банковской карты, можно переводить деньги с одной карты на другую. Есть графический интерфейс и API. Есть даже ролевая модель! И даже ТЗ есть, хоть и не супер подробное =)
