Перейти к основному содержимому

Создание GraphQL-запроса типа query

GraphQL-запрос типа query позволяет выбирать данные, соответствующие определенному критерию. Для GraphQL-запроса должны быть определены входные и выходные данные.

Чтобы создать GraphQL-запрос типа query:

  1. В окне Конструктор GraphQL введите ключевое слово query и имя GraphQL-запроса.
  2. В круглых скобках укажите имя переменной с префиксом $ и тип переменной.
  3. В фигурных скобках введите GraphQL-тип, соответствующий GraphQL-запросу, например, projectsanddocs_project. Используйте возможности IntelliSense для ускорения ввода.
  4. В фигурных скобках укажите условие выборки, используя определенную в п.2 переменную в качестве значения параметра условия, например, (where: {Id: {eq:$targetId}}).
  5. Для формирования блока запрашиваемых данных в фигурных скобках введите ключевое слово items, затем введите пару фигурных скобок.
  6. В фигурных скобках для элемента items последовательно введите или выберите из списка вариантов атрибуты, которые вы хотите иметь в списке выходных данных GraphQL-запроса.

Для проверки работоспособности запроса в блоке Переменные окна Конструктор GraphQL в фигурных скобках введите имя переменной (без префикса $) в двойных кавычках и через двоеточие введите значение переменной.

Следующий пример демонстрирует GraphQL-запрос типа query для получения данных о проекте с определенным идентификатором.

query getProjectById($targetId: Int) {
projectsanddocs_project(where: {Id: {eq:$targetId}})
{
items
{
name
manager
customer
}
}
}