SYSTEM ATLASЗагрузка материала

Контракт пагинации API

API Pagination Contract

Явные правила размера страницы, курсора, порядка, завершения выборки и стабильности результатов между запросами.

Простыми словами

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

Пример от @Vibeclakr

Пример при разработке

Например, для «Контракт пагинации API» назначают ответственного и добавляют тест или метрику, по которой видно реальный результат.

Это редакционный пример применения, а не часть определения или доказательство концепции.

Формальное определение

Явные правила размера страницы, курсора, порядка, завершения выборки и стабильности результатов между запросами.

Механизм действия

Для «Контракт пагинации API» команда фиксирует область действия, владельца, проверяемый сигнал и поведение при нарушении условия.

Пример в работе

Нерабочий подход

Повторять термин «Контракт пагинации API», не объяснив, где он применяется, кто отвечает и по какому признаку видно результат.

Системный подход

Связать «Контракт пагинации API» с конкретным сценарием, автоматической или ручной проверкой и правилом пересмотра.

Ограничения

«Контракт пагинации API» решает ограниченную задачу и не заменяет проверку соседних рисков, исходных допущений и последствий для всей системы.

Источник

IETF, “RFC 9205: Building Protocols with HTTP”, 2022.

Первоисточник