Dołączanie i konfigurowanie zasad w plikach XML

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Zasady możesz tworzyć i edytować lokalnie, korzystając z ulubionego edytora tekstu lub edytora obsługującego XML albo IDE. W tym artykule jako przykład tworzenia, konfigurowania, dołączania, wdrażania, i testowania zasad używamy typu zasady Quota.

Większość serwerów proxy interfejsu API wymusza stosowanie limitu. Limity pozwalają kontrolować, jak często aplikacja kliencka może wywoływać interfejs API w danym przedziale czasu. W przykładzie poniżej zasada Quota jest skonfigurowana tak, aby ograniczać aplikacje do 1 żądania na minutę. (Chociaż może to nie być realistyczne, zapewnia prosty sposób na sprawdzenie efektów działania zasady).

W konfiguracji serwera proxy interfejsu API pliki zasad są przechowywane jako pliki XML w katalogu /apiproxy/policies.

Na przykład zasadę typu Quota o nazwie "QuotaPolicy" można utworzyć jako plik o nazwie QuotaPolicy.xml z tą zawartością:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

Możesz utworzyć plik tekstowy ręcznie lub wygenerować zasadę na podstawie schematu XML. Wszystkie zasady mają pewne ustawienia, które są specyficzne dla danego typu zasady, oraz ustawienia ogólne dla wszystkich zasad.

Gdy dołączasz zasady w interfejsie zarządzania, narzędzie do tworzenia serwera proxy interfejsu API generuje instancję zasady na podstawie schematu XML dla wybranego typu zasady. Dlatego w konfiguracji zasady mogą występować elementy które w celu uniknięcia wątpliwości nie zawsze są uwzględniane w dokumentacji.

Wszystkie zasady definiują te atrybuty:

  • enabled: wskazuje, czy zasada jest „włączona” czy „wyłączona”. Zasady można włączać i wyłączać w czasie działania, zmieniając to ustawienie. Zasada, w której enabled ma wartość false, nie jest egzekwowana.
  • continueOnError: określa, czy potok ma kontynuować przetwarzanie wiadomości, jeśli zasada nie powiedzie się. W przypadku egzekwowania zasad dotyczących limitów błędy prawdopodobnie wskazują, że limit został przekroczony, dlatego ten atrybut powinien mieć wartość false.
  • name: nazwa, którą nadajesz tej zasadzie. Ta nazwa jest unikalna dla tej instancji zasady i służy do dołączania zasady do przepływu jako kroku przetwarzania.

W przykładzie powyżej elementy Allow, Interval i TimeUnit są specyficzne dla zasady Quota. Te elementy zawierają ustawienia, które usługi interfejsu API wymuszają w imieniu interfejsu API. Inne typy zasad definiują własne ustawienia, które możesz poznać w dokumentacji zasad.