Разбиение на страницы

Краткий обзор

Узнайте, как работает пагинация на основе курсоров в API Altium 365: от структуры ответов типа connection до навигации по коллекциям и получения количества элементов. В этой статье описаны аргументы запросов и метаданные пагинации, которые используются для запроса первой страницы и перехода между страницами результатов. Читайте дальше, чтобы освоить эти приемы на практике.

- Разберитесь, как 'nodes', 'pageInfo' и 'totalCount' формируют структуру ответа с пагинацией.
- Узнайте, как получить первую страницу и использовать курсоры для перехода вперед или назад.
- Посмотрите, как получить общее количество элементов в коллекции, не загружая сами элементы.
Узнайте больше с ИИ:

API Altium 365 использует пагинацию на основе курсоров в соответствии со спецификацией соединений Relay. Запросы к коллекциям возвращают объект типа connection, содержащий список узлов, метаданные пагинации и курсоры для перемещения вперёд или назад по результатам.

Структура соединения

Ответ с пагинацией имеет следующую структуру:

query {
  someCollection {
    nodes {        # the items on this page
      ...
    }
    pageInfo {     # pagination metadata
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    totalCount     # total number of items (all pages)
  }
}

Получение страниц

Используйте аргументы first и after для перехода вперёд по страницам коллекции:

query {
  desProjects(first: 20, after: "{cursor}") {
    nodes {
      id
      name
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
  • first – количество возвращаемых элементов (размер страницы)

  • after – курсор, указывающий на конец предыдущей страницы; не указывайте его в первом запросе

Значение endCursor из pageInfo становится значением after для следующей страницы. Продолжайте, пока hasNextPage не примет значение false.

Для перехода назад по страницам используйте last и before вместе с startCursor.

Первый запрос

Для первой страницы не указывайте аргумент after:

query {
  desProjects(first: 20) {
    nodes {
      id
      name
      updatedAt
    }
    pageInfo {
      hasNextPage
      endCursor
    }
    totalCount
  }
}

Используйте totalCount, чтобы определить ожидаемое количество страниц до начала постраничного получения данных.

Подсчёт без получения элементов

Если вам нужно только общее количество элементов, можно полностью исключить nodes:

query {
  desProjects {
    totalCount
  }
}

 

AI-LocalizedЛокализовано с помощью ИИ
Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.
Contents
Contents