INTEGRITY Документация

← Cloudflare API Shield / api-shield / reference

Classic Schema validation (устарело)

Используйте API Shield интерфейс для настройки API Schema validation, который проверяет запросы согласно Схема API который вы предоставляете.

Прежде чем настраивать Schema validation для API, вам нужно получить файл схемы API, соответствующий нашей спецификации.

Если вы используете Schema validation 2.0, вы можете изменять настройки, но не можете добавлять новые схемы Classic Schema validation.

Создание API Shield со Schema validation

Чтобы настроить Schema validation в панели Cloudflare:

  1. Войдите в Панель управления Cloudflare ↗ и выберите свой аккаунт и домен.
  2. Выберите Безопасность > API Shield.
  3. Перейдите в Schema validation и выберите Добавление схемы.
  4. Введите понятное название политики и при необходимости измените выражение, запускающее Schema validation. Например, если ваш API доступен по адресу http://api.example.com/v1, включите проверку Имя хоста поле, равное api.example.com и проверку URI Path поле с помощью регулярного выражения, соответствующего выражению ^/v1.
  1. Выберите Далее.
  2. Загрузите файл схемы.
  3. Выберите Save чтобы проверить содержимое файла схемы и развернуть правило Schema validation. Если возникнет ошибка проверки, убедитесь, что вы используете один из поддерживаемые форматы файлов и что каждая пара конечная точка/метод имеет уникальный идентификатор операции.

После развёртывания правила API Shield Cloudflare отображает сводку по всем Конечные точки API, сгруппированные по уровню защиты, и действия, которые выполняются для несоответствующих и незащищённых запросов.

  1. В Действие конечной точки в раскрывающемся списке выберите действие для каждого запроса, который обращается к защищенной конечной точке и не проходит Schema validation.
  2. В Fallthrough action в раскрывающемся списке выберите действие для каждого запроса, который обращается к незащищенной конечной точке.
  3. При необходимости можно одновременно сохранить конечные точки в Endpoint Management при сохранении схемы, выбрав Сохраняйте новые конечные точки в управление эндпоинтами. Конечные точки будут сохранены независимо от того, сохранена ли схема как черновик или опубликована.
  4. Выберите Готово.