Расширение x-yc-apigateway:smartWebSecurity

Расширение x-yc-apigateway:smartWebSecurity защищает API-шлюз на основе правил, заданных в профиле безопасности Yandex Smart Web Security. Например, с помощью базовых правил можно блокировать нежелательный трафик, а используя Advanced Rate Limiter — устанавливать ограничения на количество запросов.

Тарифицируются только те запросы к API-шлюзу, которые не были заблокированы в результате проверки. За работу профиля безопасности плата взимается отдельно согласно правилам тарификации Yandex Smart Web Security.

Поддерживаемые параметрыПоддерживаемые параметры

В таблице ниже перечислены параметры, специфичные для API-шлюза сервиса API Gateway. Описание остальных параметров читайте в спецификации OpenAPI 3.0.

Спецификация расширенияСпецификация расширения

Пример спецификации:

openapi: "3.0.0"

x-yc-apigateway:
  smartWebSecurity:
    securityProfileId: fev6q4qqnn2q********

info:
  version: 1.0.0
  title: Protected pet store
  license:
    name: MIT
paths:
  /:
    get:
      x-yc-apigateway-integration:
        type: dummy
        content:
          '*': "This pet store is protected by SWS!"
        http_code: 200

Примеры использованияПримеры использования

• Защита API Gateway при помощи интеграции с Smart Web Security