Dołączanie i konfigurowanie zasad w interfejsie

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

Dodawanie możliwości opartych na zasadach do serwera proxy interfejsu API składa się z 2 etapów:

1. Skonfiguruj instancję typu zasady.
2. Podłącz instancję zasady do przepływu.

Poniższy diagram przedstawia relację między zasadami a przepływami. Jak widać, zasada jest dołączona do procesu jako „Krok” przetwarzania. Aby skonfigurować pożądane działanie interfejsu API, musisz dowiedzieć się więcej o przepływach. (Ten temat został omówiony wcześniej w sekcji Konfigurowanie przepływów).

Jednym z powszechnie stosowanych zasad jest SpikeArrest. SpikeArrest zapobiega nagłemu wzrostowi ruchu związanego z wiadomościami, który może osłabić działanie usług backendu.

Dołączanie zasady do procesu

Aby dołączyć zasadę do procesu:

1. Wybierz serwer proxy interfejsu API i przejdź do widoku Develop (Programowanie).
2. W panelu nawigacji w edytorze proxy interfejsu API wybierz proces, do którego chcesz dołączyć zasadę.
   Na przykład przepływ PreFlow jest wybrany dla domyślnego punktu końcowego serwera proxy interfejsu API na tym ilustracji:
   
3. W widoku projektu kliknij +Krok powiązany z procesem żądania lub odpowiedzi, aby dołączyć zasadę. Na przykład:
   
   Otworzy się okno Dodaj krok z listą zasad podzielonej na kategorie.
   
4. Przewiń i wybierz typ zasady, który chcesz dołączyć do wybranego procesu.
5. Zmodyfikuj poniższe pola.

   • Wyświetlana nazwa: niepowtarzalna wyświetlana nazwa zasady. Interfejs wygeneruje nazwę domyślną, ale zalecamy utworzenie opisowej nazwy zasady. Dzięki temu inni deweloperzy w Twojej organizacji będą mogli łatwo zrozumieć, do czego służy dana zasada.

   • Nazwa: niepowtarzalna nazwa zasady. Nazwa zasady jest zgodna z wyświetlaną nazwą z tymi wyjątkami:

     • Spacje są zastępowane myślnikami.

     • Myślniki, które znajdują się po sobie, są zastępowane pojedynczym łącznikiem.

     • Z wyjątkiem myślników, podkreśleń i spacji (zastępowanych, jak zaznaczono powyżej) znaki niebędące znakami alfanumerycznymi, np. funt, procent, ampersand itp., są usuwane.

6. Kliknij Dodaj.

   Zasada jest połączona z wybranym procesem.

Po dołączeniu zasady zobaczysz ją w widoku Projektant dla przepływu, w tym przykładzie wstępnym procesie domyślnego punktu końcowego serwera proxy oraz na liście Zasady w panelu nawigacji. Pod widokiem Projektanta wyświetli się widok Kod, który zawiera kod XML nowo dołączonej zasady. Edge generuje instancję zasady, która zawiera zbiór rozsądnych wartości domyślnych.

Dodawanie zasady bez dołączania jej do procesu

Aby dodać zasadę bez dołączania jej do procesu, co jest przydatne w przypadku obsługi błędów, kliknij + na pasku Zasady w widoku Nawigator, aby otworzyć okno Dodaj zasadę, i dodaj zasadę (zgodnie z krokami 4–6 w poprzedniej sekcji).

Zasada, która nie jest dołączona do żadnego procesu, jest oznaczona na liście Zasady ikoną „odłączona”, jak pokazano obok zasady dotyczącej komunikatów klucza interfejsu API pokazanej na poprzedniej ilustracji.

Po utworzeniu zasady możesz ją dołączyć do procesu, przeciągając ją z listy Zasady i upuszczając w odpowiednim przepływie w widoku Projektant.

Odłączanie zasad od procesu

Aby odłączyć zasadę od przepływu, wybierz Przepływ. Najedź kursorem myszy na ikonę zasady w widoku Projektor przepływu pracy. Kliknij X w kółku, które pojawi się na ikonie.

Usuwanie instancji zasad

Aby usunąć instancję zasady, najedź kursorem na wpis zasady w widoku Nawigator. Kliknij X w kółku, które pojawi się po prawej stronie wpisu.

Konfigurowanie zasad w interfejsie

Gdy interfejs generuje instancję zasady, stosuje uzasadnione wartości domyślne do typowych ustawień. Aby spełnić wymagania, konieczne może być zmodyfikowanie tych ustawień.

Przykład:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1">
  <DisplayName>SpikeArrest-1</DisplayName>
  <FaultRules/>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
</SpikeArrest>

Możesz skonfigurować zasadę, edytując jej konfigurację XML bezpośrednio w widoku Kod. Na przykład szczytowa częstotliwość wiadomości w zasadzie Spike Arrest jest początkowo ustawiona na 30 wiadomości na sekundę. Częstotliwość szczytową możesz zmienić, zmieniając wartość elementu <Rate> w pliku XML zasady. Więcej informacji o konfigurowaniu zasad znajdziesz w dokumentacji zasad.

Możesz też wycinać i wklejać zasady w widoku Kod. To świetny sposób na ponowne wykorzystanie zasad z przykładów dostępnych w GitHubie.

Gdy wprowadzisz zmiany w definicji zasady w widoku Kod, zostaną one odzwierciedlone w Inspektorze właściwości. I w drugą stronę: zmiany możesz wprowadzać w Inspektorze właściwości, a pojawią się one w pliku XML w widoku Kod.

Dokumentację dotyczącą zasad dotyczących limitów w tym temacie znajdziesz w sekcji Zasady dotyczące limitów.