Что такое правила?

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

Apigee Edge позволяет "программировать" поведение API без написания кода, используя "правила". Правило похоже на модуль, который реализует определенную ограниченную функцию управления. Правила позволяют легко и надежно добавлять в API распространенные функции управления. Правила предоставляют такие функции, как безопасность, ограничение скорости, преобразование и медиация, избавляя вас от необходимости самостоятельно писать код и поддерживать эти функции.

Вы не ограничены набором типов правил, предоставляемых Apigee Edge. Вы также можете писать собственные скрипты и код (например, приложения JavaScript и Node.js), которые расширяют функциональность прокси-сервера API и позволяют вам создавать инновационные решения на основе базовых возможностей управления, поддерживаемых правилами Apigee.

Типы правил

Технически правило представляет собой файл конфигурации в формате XML. Структура каждого типа правил (например, обязательные и необязательные элементы конфигурации) определяется схемой XML. Если вы хорошо знакомы с инструментами XML, рекомендуем изучить схемы правил в примерах для платформы API на GitHub.

Типы правил Edge сгруппированы по следующим функциональным категориям:

Управление трафиком

Правила из категории управления трафиком позволяют контролировать поток запросов и ответов через прокси-сервер API. Эти правила поддерживают контроль как на уровне операций, так и на уровне бизнеса. Они позволяют контролировать пропускную способность и трафик для каждого приложения. Правила управления трафиком позволяют применять квоты и помогают предотвращать атаки типа "отказ в обслуживании".

Безопасность

Правила в категории "Безопасность" поддерживают аутентификацию, авторизацию и безопасность на основе контента.

Медиация

Правила из категории "Медиация" позволяют активно управлять сообщениями, которые передаются через прокси API. Они позволяют преобразовывать форматы сообщений, например из XML в JSON и наоборот, или из одного формата XML в другой. Они также позволяют анализировать письма, создавать новые письма и изменять значения в исходящих письмах. Правила медиации также взаимодействуют с основными сервисами, предоставляемыми API Services, что позволяет вам получать данные о приложениях, разработчиках, токенах безопасности и продуктах API во время выполнения.

Расширение

Правила в категории "Расширения" позволяют использовать расширяемость API-сервисов для реализации пользовательского поведения на выбранном вами языке программирования.

Подробное описание каждого типа правил приведено в обзоре справочной информации о правилах. В этом разделе показано общее взаимодействие, как создавать правила и прикреплять их к потокам в конфигурации прокси-сервера API.

Как развернуть изменения в правилах

Чтобы изменения правил вступили в силу, необходимо развернуть версию прокси API в среде. После того как вы прикрепите правило или измените существующее, используйте интерфейс управления или API управления, чтобы развернуть изменения.

Как проверить, применяются ли правила

Чтобы убедиться, что правила применяются правильно, API должен вызываться HTTP-клиентом. Чтобы проверить конфигурацию квоты, отправьте в API несколько запросов, превышающих установленный лимит. (Путь URI, настроенный как базовый путь в ProxyEndpoint, в приведенном ниже запросе – /weather).

http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282

Если вы отправите более одного запроса в минуту, появится следующее сообщение об ошибке:

{  
   "fault":{  
      "faultstring":"policies.ratelimit.QuotaViolation",
      "detail":{  
         "errorcode":"policies.ratelimit.QuotaViolation"
      }
   }
}

Это означает, что правила квоты применяются сервисами API.

Обработка ошибок на основе правил

Обратите внимание на формат сообщения об ошибке выше. Она содержит свойства faultstring и errorcode. Во многих случаях вам нужно реализовать определенное поведение для обработки этих ошибок. Например, вы можете отправить разработчику, чье приложение превысило квоту, сообщение с предупреждением.

Подробнее об обработке ошибок…

Рекомендации: распространенные наборы правил

Чтобы соответствовать основным требованиям к управлению, прокси API обычно применяют следующие правила:

Базовая проверка ключа API

1. SpikeArrest
2. XMLThreatProtection или JSONThreatProtection
3. Проверка ключа API
4. Квота
5. ResponseCache

1. ResponseCache

Базовое преобразование: JSON в XML

1. SpikeArrest
2. JSONThreatProtection
3. Проверка ключа API
4. Квота
5. JSONToXML

1. XMLToJSON
2. ResponseCache