Dołączanie i konfigurowanie zasad w plikach XML

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. informacje.

Możesz tworzyć i edytować zasady lokalnie za pomocą ulubionego edytora tekstu, edytora XML lub IDE. W tym temacie użyto typu zasady dotyczącej limitów jako przykładu tworzenia, konfigurowania, podłączania, wdrażania i testowania zasad.

Większość serwerów proxy interfejsu API wymusza limit. Limity zapewniają kontrolę nad tym, jak często aplikacja kliencka może wywoływać interfejs API w danym przedziale czasu. W przykładzie poniżej zasada limitu jest skonfigurowana tak, aby ograniczać aplikacje do 1 żądania na minutę. Może to nie być realistyczne, ale pozwala w prosty sposób poznać efekty danej zasady.

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

Na przykład zasadę typu „QuotaPolicy” o nazwie „QuotaPolicy” można utworzyć jako plik o nazwie QuotaPolicy.xml o następującej treści:

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

Plik tekstowy możesz utworzyć ręcznie lub wygenerować na podstawie schematu XML. Wszystkie zasady mają ustawienia specyficzne dla danego typu, a niektóre są ogólne we wszystkich zasadach.

Gdy dołączysz zasady w interfejsie zarządzania, kreator proxy interfejsu API wygeneruje instancję zasad na podstawie schematu XML dla wybranego typu zasad. Dlatego w konfiguracji zasad mogą się pojawić elementy, które, aby rozwiać wątpliwości, nie zawsze są uwzględnione w dokumentacji.

Wszystkie zasady definiują te atrybuty:

  • enabled: wskazuje, czy zasada jest włączona czy wyłączona. Zmieniając to ustawienie, zasady można włączać i wyłączać w czasie działania. Zasada, dla której enabled ma wartość false, nie jest egzekwowana.
  • continueOnError: określa, czy potok powinien kontynuować przetwarzanie wiadomości, jeśli zasada nie powiedzie się. Przy egzekwowaniu zasad limitów błędy prawdopodobnie oznaczają przekroczenie limitu i dlatego ten atrybut powinien mieć wartość Fałsz.
  • name: nazwa nadana przez Ciebie zasadzie. Nazwa ta jest unikalna dla tej instancji zasady i jest używana do dołączania zasady do procesu w ramach etapu przetwarzania.

W powyższym przykładzie elementy Allow, Interval i TimeUnit odnoszą się do zasady dotyczącej limitów. Te elementy udostępniają ustawienia, które usługi API egzekwują w imieniu interfejsu API. Inne typy zasad definiują własne ustawienia. Więcej informacji znajdziesz w dokumentacji zasad.