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

Маска полей API

API Field Mask

Явное перечисление полей объекта, которые клиент хочет прочитать или изменить, вместо передачи полного представления.

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

Например, в проекте «Маска полей API» оформляется как проверяемое правило с владельцем, тестом или метрикой и наблюдаемым результатом. Поэтому проверяют весь путь запроса от браузера до сервера и обратно - иначе локально правильное решение может ухудшить загрузку, совместимость или устойчивость страницы.

Пример от @Vibeclakr

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

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

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

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

Явное перечисление полей объекта, которые клиент хочет прочитать или изменить, вместо передачи полного представления.

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

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

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

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

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

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

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

Ограничения

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

Источник

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

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