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

Контракт фильтрации API

API Filtering Contract

Определение доступных полей, операторов, комбинаций и поведения ошибочных фильтров.

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

Фильтры API - это тоже контракт. Сервер должен явно сказать, какие поля и операторы поддерживаются, как их комбинировать и что произойдёт при неверном фильтре.

Пример от @Vibeclakr

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

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

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

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

Определение доступных полей, операторов, комбинаций и поведения ошибочных фильтров.

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

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

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

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

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

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

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

Ограничения

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

Источник

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

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