Dołączanie i konfigurowanie zasad w plikach XML

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Możesz tworzyć i edytować zasady lokalnie za pomocą ulubionego edytora tekstu, edytora XML lub IDE. W tym artykule na przykładzie typu zasady dotyczącej limitu łączymy tworzenie, konfigurowanie, dołączanie, wdrażanie i testowanie zasad.

Większość serwerów proxy interfejsu API stosuje limity. Limity pozwalają kontrolować, jak często aplikacja kliencka jest ma uprawnienia do wywoływania interfejsu API w danym przedziale czasu. W przykładzie poniżej zasada dotycząca limitów to skonfigurowana pod kątem ograniczenia liczby aplikacji do 1 żądania na minutę. (Chociaż może to nie być realistyczne, jest to prosty sposób na sprawdzenie skuteczności zasad).

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

Na przykład zasadę typu Quota o nazwie „QuotaPolicy” można utworzyć jako plik o nazwie QuotaPolicy.xml z takimi treściami:

<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 specyficzne dla danego typu zasad, a pewne ustawienia dla wszystkich zasad.

Gdy dołączysz zasady w interfejsie zarządzania, kreator serwerów proxy interfejsów API generuje zasady ze schematu XML dla wybranego typu zasady. W związku z tym możesz zobaczyć w konfiguracji zasad, które dla jasności nie zawsze są uwzględniane w dokumentacji.

Wszystkie zasady definiują te atrybuty:

  • enabled: wskazuje, czy zasada jest włączona. lub „wyłączony”. Zasady mogą być włączane/wyłączane w czasie działania przez zmianę tego ustawienia. Zasada, która zawiera enabled ustawiona na false nie jest wymuszana.
  • continueOnError: określa, czy potok powinien nadal przetwarzać w przypadku niepowodzenia. Przy egzekwowaniu zasad dotyczących limitów błędy prawdopodobnie wskazują, że limit został przekroczony i dlatego ten atrybut powinien mieć wartość false (fałsz).
  • name: nazwa, jaką nadajesz danej zasadzie. Ta nazwa jest unikalna dla tego wystąpienia zasady i służy do dołączania zasady do przepływu jako kroku przetwarzania.

W powyższym przykładzie elementy Allow, Interval oraz TimeUnit odnoszą się do zasad dotyczących limitów. Te elementy określają ustawienia interfejsu API Usługi są egzekwowane w imieniu interfejsu API. Inne typy zasad definiują własne ustawienia, więcej dowiesz się z informacji o zasadach.