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

Долговыполняемая операция API

API Long-Running Operation

Асинхронный контракт для операции, которая возвращает ресурс состояния и позволяет опрашивать прогресс и итог.

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

Некоторые операции занимают секунды или минуты, поэтому держать один HTTP-запрос открытым неудобно. Сервер быстро возвращает идентификатор задачи, а клиент затем проверяет её состояние и получает итог.

Пример от @Vibeclakr

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

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

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

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

Асинхронный контракт для операции, которая возвращает ресурс состояния и позволяет опрашивать прогресс и итог.

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

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

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

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

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

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

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

Ограничения

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

Источник

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

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