Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info
Instrukcje warunkowe to powszechna struktura sterująca we wszystkich językach programowania. Podobnie jak język programowania, konfiguracja serwera proxy interfejsu API obsługuje instrukcje warunkowe dla przepływów, zasad, kroków i reguł tras. Definiując instrukcje warunkowe, określasz dynamiczne zachowanie interfejsu API. To dynamiczne zachowanie pozwala na przykład konwertować XML na JSON tylko w przypadku urządzeń mobilnych lub kierować do adresu URL backendu na podstawie typu treści lub czasownika HTTP wiadomości żądania.
Z tego artykułu dowiesz się, jak używać warunków do dynamicznego stosowania funkcji zarządzania interfejsami API w czasie działania bez pisania kodu.
Konfigurowanie instrukcji warunkowych
Zachowanie warunkowe jest implementowane w serwerach proxy interfejsu API za pomocą kombinacji warunków i zmiennych. Instrukcję warunkową tworzy się za pomocą elementu Condition. Poniżej znajduje się pusty warunek:
<Condition></Condition>
Aby utworzyć instrukcję warunkową, dodaj operator warunkowy i zmienną, aby utworzyć tę strukturę:
<Condition>{variable.name}{operator}{"value"}</Condition>
Obsługiwane operatory warunkowe to = (równa się), != (nie równa się) i > (większe niż). Dla czytelności możesz też zapisać warunki jako tekst: equals, notequals, greaterthan.
Podczas pracy ze ścieżkami identyfikatorów URI możesz używać ~/ lub MatchesPath. Możesz też dopasowywać wyrażenia regularne JavaRegex za pomocą operatora ~~.
Warunki służą do definiowania przepływów warunkowych serwera proxy interfejsu API do zasobów interfejsu API backendu, opisanych w artykule Tworzenie przepływów warunkowych do zasobów interfejsu API backendu. Pełną listę warunków znajdziesz w dokumentacji warunków.
Zmienne
Warunki działają, oceniając wartości zmiennych. Zmienna to właściwość transakcji HTTP wykonywanej przez serwer proxy interfejsu API lub właściwość samej konfiguracji serwera proxy interfejsu API. Za każdym razem, gdy serwer proxy interfejsu API otrzymuje żądanie od aplikacji, Apigee Edge wypełnia długą listę zmiennych powiązanych z takimi elementami jak czas systemowy, informacje o sieci aplikacji, nagłówki HTTP w wiadomościach, konfiguracja serwera proxy interfejsu API, wykonywanie zasad itp. W ten sposób powstaje bogaty kontekst, którego możesz użyć do skonfigurowania instrukcji warunkowych.
Zmienne zawsze używają notacji kropkowej. Na przykład nagłówki HTTP w komunikacie żądania są dostępne jako zmienne o nazwie request.header.{header_name}. Aby ocenić nagłówek Content-type, możesz użyć zmiennej request.header.Content-type. Na przykład request.header.Content-type = "application/json" wskazuje, że typem treści żądania powinien być JSON.
Wyobraź sobie, że musisz utworzyć instrukcję warunkową, która spowoduje, że zasada będzie egzekwowana tylko wtedy, gdy komunikat żądania będzie typu GET. Aby utworzyć warunek, który ocenia czasownik HTTP żądania, utwórz instrukcję warunkową poniżej. Zmienna w tym warunku to request.verb. Wartość zmiennej to GET. Operator to =.
<Condition>request.verb = "GET"</Condition>
<Condition>request.verb equals "GET"</Condition>
Edge używa takiej instrukcji do oceny warunków. Powyższy przykład zwraca wartość „true”, jeśli czasownik HTTP powiązany z żądaniem to GET. Jeśli czasownik HTTP powiązany z żądaniem to POST, instrukcja ma wartość false.
Aby włączyć dynamiczne zachowanie, możesz dołączyć warunki do przepływów, kroków i reguł tras.
Gdy dołączysz warunek do przepływu, utworzysz „przepływ warunkowy”. Przepływy warunkowe są wykonywane tylko wtedy, gdy warunek ma wartość „prawda”. Do przepływu warunkowego możesz dołączyć dowolną liczbę zasad. Przepływ warunkowy umożliwia tworzenie wysoce wyspecjalizowanych reguł przetwarzania żądań lub odpowiedzi, które spełniają określone kryteria.
Aby na przykład utworzyć przepływ, który jest wykonywany tylko wtedy, gdy czasownik żądania to GET:
<Flows> <Flow name="ExecuteForGETs"> <Condition>request.verb="GET"</Condition> </Flow> </Flows>
Aby utworzyć jeden przepływ dla żądań GET i drugi dla żądań POST:
<Flows> <Flow name="ExecuteForGETs"> <Condition>request.verb="GET"</Condition> </Flow> <Flow name="ExecuteForPOSTs"> <Condition>request.verb="POST"</Condition> </Flow> </Flows>
Jak pokazano w przykładzie poniżej, warunek możesz zastosować do samego kroku zasady. Poniższy warunek powoduje, że zasada VerifyApiKey jest egzekwowana tylko wtedy, gdy wiadomość żądania jest typu POST.
<PreFlow name="PreFlow">
<Request>
<Step>
<Condition>request.verb equals "POST"</Condition>
<Name>VerifyApiKey</Name>
</Step>
</Request>
</PreFlow>Po zdefiniowaniu takich przepływów warunkowych możesz dołączyć do nich zasady, dzięki czemu serwer proxy interfejsu API będzie mógł egzekwować jeden zestaw zasad w przypadku żądań GET i inny zestaw zasad w przypadku żądań POST.
Szczegółowe informacje znajdziesz w tych materiałach:
Przykład 1
Poniższy przykład pokazuje pojedynczy przepływ warunkowy o nazwie Convert-for-devices skonfigurowany w przepływie odpowiedzi ProxyEndpoint. Dodaj warunek jako element do encji, której dotyczy. W tym przykładzie warunek jest komponentem przepływu.
Dlatego przepływ będzie wykonywany zawsze, gdy instrukcja będzie miała wartość „true”.
<Flows>
<Flow name="Convert-for-devices">
<Condition>(request.header.User-Agent = "Mozilla")</Condition>
<Response>
<Step><Name>ConvertToJSON</Name></Step>
</Response>
</Flow>
</Flows>W przypadku każdego żądania otrzymanego z aplikacji Edge przechowuje wartości wszystkich nagłówków HTTP jako zmienne. Jeśli żądanie zawiera nagłówek HTTP o nazwie User-Agent, ten nagłówek i jego wartość są przechowywane jako zmienna o nazwie request.header.User-Agent.
Biorąc pod uwagę powyższą konfigurację ProxyEndpoint, Edge sprawdza wartość zmiennej request.header.User-Agent, aby sprawdzić, czy warunek jest spełniony.
Jeśli warunek jest spełniony, czyli wartość zmiennej request.header.User-Agent jest równa Mozilla, wykonywany jest przepływ warunkowy i egzekwowana jest zasada XMLtoJSON o nazwie ConvertToJSON. Jeśli nie, przepływ nie zostanie wykonany, a odpowiedź XML zostanie zwrócona do aplikacji wysyłającej żądanie bez zmian (w formacie XML).
Przykład 2
Posłużmy się konkretnym przykładem, w którym musisz przekształcić wiadomość z odpowiedzią z formatu XML na JSON, ale tylko w przypadku urządzeń mobilnych. Najpierw utwórz zasadę, która przekonwertuje odpowiedź w formacie XML z interfejsu Weather API na format JSON:
<XMLToJSON name="ConvertToJSON"> <Options> </Options> <OutputVariable>response</OutputVariable> <Source>response</Source> </XMLToJSON>
Powyższa konfiguracja zasad informuje serwer proxy interfejsu API, aby pobrał komunikat odpowiedzi, przeprowadził konwersję z XML na JSON z ustawieniami domyślnymi, a następnie zapisał wynik w nowym komunikacie odpowiedzi. (Jeśli konwertujesz komunikat żądania z XML na JSON, po prostu ustaw obie te wartości na request).
Ponieważ chcesz przekonwertować odpowiedzi z XML na JSON, musisz skonfigurować warunkowy przepływ odpowiedzi, który wykona konwersję. Aby na przykład przekonwertować wszystkie odpowiedzi z XML na JSON, zanim zostaną zwrócone do aplikacji klienckiej, skonfiguruj ten przepływ odpowiedzi ProxyEndpoint.
<Flows>
<Flow name="Convert-for-devices">
<Response>
<Step><Name>ConvertToJSON</Name></Step>
</Response>
</Flow>
</Flows>Gdy wywołujesz interfejs API za pomocą standardowego żądania, odpowiedź jest sformatowana w formacie JSON.
Twoim celem jest jednak konwertowanie raportów pogodowych na format JSON tylko wtedy, gdy klientem wysyłającym żądanie jest urządzenie mobilne. Aby włączyć takie dynamiczne działanie, musisz dodać do przepływu instrukcję warunkową.
Testowanie automatyzacji warunkowej
W tym przykładowym żądaniu nagłówek HTTP User-Agent jest ustawiony na Mozilla, co powoduje, że instrukcja warunkowa przyjmuje wartość true i wykonywany jest przepływ warunkowy Convert-for-devices.
$ curl -H "User-Agent:Mozilla" http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282
lub, aby zastosować formatowanie stylistyczne, gdy dostępny jest Python:
$ curl -H "User-Agent:Mozilla" http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282 | python -mjson.tool
Przykładowa odpowiedź:
. . .
"yweather_forecast": [
{
"code": "11",
"date": "12 Dec 2012",
"day": "Wed",
"high": "55",
"low": "36",
"text": "Showers"
},
{
"code": "32",
"date": "13 Dec 2012",
"day": "Thu",
"high": "56",
"low": "38",
"text": "Sunny"
}
]
}
. . .Żądanie przesłane bez nagłówka User-Agent lub z wartością inną niż Mozilla spowoduje zwrócenie odpowiedzi w formacie XML.
$ curl http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282
Zwracana jest niezmieniona odpowiedź XML.
Przykładowa odpowiedź:
<yweather:forecast day="Wed" date="12 Dec 2012" low="36" high="55" text="Showers" code="11" /> <yweather:forecast day="Thu" date="13 Dec 2012" low="38" high="56" text="Sunny" code="32" />
Dopasowywanie wzorców
W tej sekcji opisano, jak używać dopasowywania wzorców z warunkami w przepływie Apigee.
Operatory
W tej sekcji opisano, jak używać w instrukcjach warunkowych tych operatorów dopasowywania wzorców:
- Operator Matches: proste dopasowywanie wzorców
- Operator JavaRegex: bardziej precyzyjna kontrola nad dopasowywaniem.
- Operator MatchesPath: dopasowywanie fragmentu ścieżki
Dopasowania
Najpierw przyjrzyjmy się operatorowi warunkowemu „Pasuje” lub „~”. Te 2 operatory są takie same – wersja angielska „Matches” jest uważana za bardziej czytelną.
Podsumowanie: operator „Matches” daje 2 możliwości. Możesz dopasować ciąg znaków dosłownie lub użyć symbolu wieloznacznego „*”. Jak można się spodziewać, symbol wieloznaczny odpowiada 0 lub większej liczbie znaków. Zobaczmy, jak to działa.
Poniższy kod XML przedstawia warunek kroku. Zasada SomePolicy jest wykonywana, gdy warunek zwraca wartość „prawda”. W tym przykładzie testujemy zmienną proxy.pathsuffix, czyli zmienną wbudowaną w Edge, która przechowuje sufiks ścieżki żądania. Pamiętaj jednak, że możesz przetestować wartość dowolnej zmiennej przepływu, która zawiera ciąg znaków. W tym przypadku, jeśli ścieżka podstawowa żądania przychodzącego to /animals, a żądanie to /animals/cat, sufiks ścieżki to ciąg znaków „/cat”.
<PreFlow name="PreFlow">
<Request>
<Step>
<Condition>(proxy.pathsuffix Matches "/cat")</Condition>
<Name>SomePolicy</Name>
</Step>
</Request>
<Response/>
</PreFlow>Pytanie: jaki sufiks ścieżki serwera proxy spowoduje wykonanie zasady SomePolicy? Jest tylko jedna możliwość.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
Czy zasada jest wykonywana? Tak, ponieważ sufiks ścieżki proxy dokładnie pasuje do „/cat”. Nie zostanie wykonany, jeśli sufiks to /bat, /dog, „/” lub inny.
Teraz rozważmy tę instrukcję warunkową, w której używamy symbolu wieloznacznego „*”:
<Condition>(proxy.pathsuffix Matches "/*at")</Condition>
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
Czy zasada jest wykonywana? Tak, ponieważ symbol wieloznaczny odpowiada dowolnemu znakowi, a "/cat" jest dopasowaniem.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/bat
Czy zasada jest wykonywana? Tak, ponieważ symbol wieloznaczny odpowiada dowolnemu znakowi, "/bat" jest dopasowaniem.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/owl
Czy zasada jest wykonywana? Zdecydowanie nie – chociaż symbol wieloznaczny pasuje do „o”, litery „wl” nie są dopasowane.
Teraz przenieśmy symbol wieloznaczny na koniec sufiksu:
<Condition>(proxy.pathsuffix Matches "/cat*")</Condition>
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
Czy zasada jest wykonywana? Tak, ponieważ symbol wieloznaczny odpowiada dowolnej liczbie dowolnych znaków.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/bat
Czy zasada jest wykonywana? Nie, „/bat” nie pasuje.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat123
Czy zasada jest wykonywana? Tak, symbol wieloznaczny odpowiada dowolnej liczbie dowolnych znaków, więc „123” pasuje do wzorca.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat/bird/mouse
Czy zasada jest wykonywana? Tak, ponieważ symbol wieloznaczny odpowiada dowolnej liczbie dowolnych znaków, więc „/bird/mouse” pasuje do wzorca. Zwróć uwagę, że takie wyrażenie może sprawić Ci kłopoty, ponieważ pasuje do wszystkiego, co znajduje się po znakach dosłownych.
Pytanie: Czy operator „Pasuje” uwzględnia wielkość liter?
Tak. Załóżmy, że masz taki warunek:
<Condition>(proxy.pathsuffix Matches "/*At")</Condition>
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
Czy zasada jest wykonywana? Nie, symbol wieloznaczny odpowiada dowolnej literze (niezależnie od wielkości), ale mała litera „a” nie odpowiada wielkiej literze „A”.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/bAt
Czy zasada jest wykonywana? Tak, wielkość liter jest zgodna.
Pytanie: Jak używać znaków modyfikacji z operatorem Dopasowania?
Aby zmienić znaczenie znaków zastrzeżonych, użyj znaku procentu „%”. Na przykład:
<Condition>(proxy.pathsuffix Matches "/c%*at")</Condition>
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
Czy zasada jest wykonywana? Nie, operator Dopasowania szuka ciągu znaków „c*at”.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/c*at
Pytanie:Czy zasada jest wykonywana?
Tak, ta ścieżka, choć nieco nietypowa, pasuje.
JavaRegex
Jak widać, operator „Dopasowania” świetnie sprawdza się w prostych sytuacjach. Możesz jednak użyć innego operatora, „JavaRegex” lub „~~”. Te 2 operatory są takie same, ale JavaRegex jest uważany za bardziej czytelny. Nazywa się JavaRegex, ponieważ umożliwia dopasowywanie wzorców wyrażeń regularnych, a Edge stosuje te same reguły co klasy w pakiecie java.util.regex w języku Java. Sposób działania operatora JavaRegex bardzo różni się od operatora Matches, dlatego ważne jest, aby ich nie pomylić.
Podsumowanie: operator „JavaRegex” umożliwia używanie składni wyrażeń regularnych w instrukcjach warunkowych.
Poniższy kod pokazuje warunek kroku. Jeśli warunek jest spełniony, wykonuje zasadę SomePolicy. W tym przykładzie testujemy zmienną proxy.pathsuffix, czyli zmienną wbudowaną w Edge, która przechowuje sufiks ścieżki żądania. Jeśli ścieżka podstawowa żądania przychodzącego to /animals, a żądanie to /animals/cat, sufiks ścieżki to ciąg znaków „/cat”.
<PreFlow name="PreFlow">
<Request>
<Step>
<Condition>(proxy.pathsuffix JavaRegex "/cat")</Condition>
<Name>SomePolicy</Name>
</Step>
</Request>
<Response/>
</PreFlow>Pytanie: jaki sufiks ścieżki serwera proxy spowoduje wykonanie zasady SomePolicy? Podobnie jak w przypadku operatora Matches, w tym przypadku jest tylko jedna możliwość.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
Czy zasada jest wykonywana? Tak, ponieważ sufiks ścieżki proxy dokładnie pasuje do „/cat”. Nie zostanie wykonany, jeśli sufiks to /bat, /dog lub inny.
Teraz utwórzmy wyrażenie regularne z użyciem kwantyfikatora „*”. Ten kwantyfikator dopasowuje zero lub więcej wystąpień poprzedzającego znaku.
<Condition>(proxy.pathsuffix JavaRegex "/c*t")</Condition>
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
Czy zasada jest wykonywana? Nie! Kwantyfikator „*” dopasowuje zero lub więcej poprzedzających znaków, czyli „c”.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/ccccct
Czy zasada jest wykonywana? Tak, ponieważ symbol wieloznaczny dopasowuje zero lub więcej poprzedzających znaków.
Następnie używamy kwantyfikatora „?”, który dopasowuje poprzedni znak raz lub wcale.
<Condition>(proxy.pathsuffix JavaRegex "/ca?t")</Condition>
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
Czy zasada jest wykonywana? Tak. Kwantyfikator „?” dopasowuje zero lub jedno wystąpienie poprzedzającego znaku, którym jest „a”.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/ct
Czy zasada jest wykonywana? Tak. Kwantyfikator „?” dopasowuje 1 lub 0 poprzedzających znaków. W tym przypadku nie ma znaku „a”, więc warunek jest spełniony.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/caat
Czy zasada jest wykonywana? Nie. Kwantyfikator „?” dopasowuje jeden poprzedzający znak, czyli „a”.
Następnie użyjemy wyrażenia regularnego w stylu „[abc]” lub „grupowanie”. Dopasowuje znaki „a”, „b” lub „c”.
<Condition>(proxy.pathsuffix JavaRegex "/[cbr]at")</Condition>
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
Czy zasada jest wykonywana? Tak. Używamy tu wyrażeń regularnych, a wyrażenie „[cbr]” pasuje do „c”, „b” LUB „r”. Te wywołania również są dopasowywane:
GET http://artomatic-test.apigee.net/matchtest/bat
GET http://artomatic-test.apigee.net/matchtest/rat
ale nie pasuje do:
GET http://artomatic-test.apigee.net/matchtest/mat
Pytanie: Czy operator JavaRegex uwzględnia wielkość liter?
Tak. Załóżmy, że masz taki warunek:
<Condition>(proxy.pathsuffix JavaRegex "/ca?t")</Condition>
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
Czy zasada jest wykonywana? Tak, wyrażenie regularne dopasowuje zero lub jeden poprzedzający znak, którym jest „a”.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cAt
Pytanie: czy zasada jest wykonywana?
Nie, ponieważ wielka litera „A” nie pasuje do małej litery „a”.
MatchesPath
Operator MatchesPath można też określić jako „~/”. Wygląda on trochę jak operatory Matches (~) i JavaRegex (~~). MatchesPath działa jednak zupełnie inaczej.
Pamiętaj, że ten operator traktuje ścieżkę jako serię części. Jeśli więc ścieżka to /animals/cats/wild, możesz ją traktować jako składającą się z części „/animals”, „/cats” i „/wild”.
Operator MatchesPath umożliwia użycie 2 notacji symboli wieloznacznych: pojedynczej gwiazdki (*) i podwójnej gwiazdki (**). Pojedyncza gwiazdka odpowiada jednemu elementowi ścieżki. Podwójna gwiazdka pasuje do co najmniej jednego elementu ścieżki.
Przeanalizujmy poniższy przykład. W tym przykładzie testujemy zmienną proxy.pathsuffix, czyli zmienną wbudowaną w Edge, która przechowuje sufiks ścieżki żądania. Pamiętaj jednak, że możesz przetestować wartość dowolnej zmiennej przepływu, która zawiera ciąg znaków.
<PreFlow name="PreFlow">
<Request>
<Step>
<Condition>(proxy.pathsuffix MatchesPath "/animals/*")</Condition>
<Name>SomePolicy</Name>
</Step>
</Request>
<Response/>
</PreFlow>Pytanie: jaki sufiks ścieżki serwera proxy spowoduje wykonanie zasady SomePolicy?
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/animals
Pytanie: czy zasada jest wykonywana?
Nie, ponieważ warunek wymaga kolejnego elementu ścieżki po „/animals”, jak określono w „/*”.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/animals/
Czy zasada jest wykonywana? Tak, ścieżka ma inny element (część po „/animals/”), ale jest on pusty.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/animals/cats
Czy zasada jest wykonywana? Tak, ponieważ ścieżka wyraźnie zawiera element („/cats”), który występuje po „/animals”
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/animals/cats/wild
Pytanie: czy zasada jest wykonywana?
Nie, ponieważ pojedyncza gwiazdka pasuje tylko do jednego elementu ścieżki, a ten interfejs API ma więcej niż jeden element po „/animals”.
Teraz użyjmy podwójnej gwiazdki:
<PreFlow name="PreFlow">
<Request>
<Step>
<Condition>(proxy.pathsuffix MatchesPath "/animals/**")</Condition>
<Name>SomePolicy</Name>
</Step>
</Request>
<Response/>
</PreFlow>Pytanie: jaki sufiks ścieżki serwera proxy spowoduje wykonanie zasady SomePolicy?
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/animals
Czy zasada jest wykonywana? Nie, ponieważ warunek wymaga co najmniej 1 elementu ścieżki określonego przez „/**”.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/animals/
Czy zasada jest wykonywana?
Tak, ścieżka ma inny element (część po „/animals/”), ale jest on pusty.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/animals/cats
Czy zasada jest wykonywana?
Tak, ponieważ ścieżka zawiera co najmniej 1 element, który występuje po „/animals”
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/animals/cats/wild
Czy zasada jest wykonywana?
Tak, ponieważ ścieżka zawiera więcej niż 1 element, który występuje po „/animals”
Mieszanie gwiazdek
Możesz używać kombinacji pojedynczej (*) i podwójnej (**) gwiazdki, aby jeszcze bardziej doprecyzować dopasowanie ścieżki.
<PreFlow name="PreFlow">
<Request>
<Step>
<Condition>(proxy.pathsuffix MatchesPath "/animals/*/wild/**")</Condition>
<Name>SomePolicy</Name>
</Step>
</Request>
<Response/>
</PreFlow>Wywołanie interfejsu API:
Wszystkie te wywołania interfejsu API będą pasować:
GET http://artomatic-test.apigee.net/matchtest/animals/cats/wild/
oraz
GET http://artomatic-test.apigee.net/matchtest/animals/dogs/wild/austrailian
oraz
GET
http://artomatic-test.apigee.net/matchtest/animals/birds/wild/american/finches
Zasoby interfejsu API
Usługi RESTful to kolekcje zasobów interfejsu API. Zasób interfejsu API to fragment ścieżki URI, który identyfikuje encję, do której deweloperzy mogą uzyskać dostęp, wywołując interfejs API. Jeśli na przykład Twoja usługa dostarcza raporty i prognozy pogody, usługa backendu może definiować 2 zasoby interfejsu API:
- http://mygreatweatherforecast.com/reports
- http://mygreatweatherforecast.com/forecasts
Podczas tworzenia serwera proxy interfejsu API (jak pokazano w sekcji Tworzenie pierwszego serwera proxy interfejsu API) tworzysz co najmniej alias podstawowego adresu URL, który jest mapowany na usługę backendu. Na przykład:
| Podstawowy adres URL backendu | Nowy/równoważny adres URL serwera proxy interfejsu API |
|---|---|
| http://mygreatweatherforecast.com | http://{your_org}-{environment}.apigee.net/mygreatweatherforecast |
W tym momencie możesz wykonywać wywołania interfejsu API do backendu, używając dowolnego podstawowego adresu URL. Ale gdy użyjesz adresu URL serwera proxy interfejsu API, sprawy zaczynają się robić interesujące.
Oprócz statystyk interfejsu API, które Edge zaczyna zbierać, gdy używasz serwera proxy interfejsu API, serwery proxy umożliwiają też definiowanie przepływów warunkowych, które są mapowane na zasoby w backendzie. Zasadniczo: „Jeśli do zasobu /reports przychodzi wywołanie GET, Edge powinien coś zrobić”.
Poniższy obraz przedstawia różnicę w działaniu między 2 adresami URL, które ostatecznie uzyskują dostęp do tego samego backendu. Jeden to adres URL zasobu bez serwera proxy, a drugi to serwer proxy interfejsu API Edge z warunkowym przepływem do tego samego zasobu backendu. Poniżej opisujemy bardziej szczegółowo przepływy warunkowe.

Jak serwery proxy interfejsu API są mapowane na konkretne zasoby backendu.
Gdy adres URL serwera proxy interfejsu API jest zmapowany na podstawowy adres URL usługi backendu (podczas tworzenia serwera proxy), możesz dodawać przepływy warunkowe do określonych zasobów, takich jak wspomniane wcześniej zasoby /reports i /forecasts.
Załóżmy, że chcesz, aby Edge „coś zrobił”, gdy nadejdą wywołania do zasobów /reports lub /forecasts. Na tym etapie nie mówisz Edge, co ma robić, tylko że ma nasłuchiwać wywołań tych zasobów. Możesz to zrobić za pomocą warunków. W serwerze proxy interfejsu API Edge możesz tworzyć przepływy warunkowe dla /reports i /forecasts. Poniższy kod XML serwera proxy interfejsu API pokazuje, jak mogą wyglądać te warunki.
<Flows>
<Flow name="reports">
<Description/>
<Request/>
<Response/>
<Condition>(proxy.pathsuffix MatchesPath "/reports") and (request.verb = "GET")</Condition>
</Flow>
<Flow name="forecasts">
<Description/>
<Request/>
<Response/>
<Condition>(proxy.pathsuffix MatchesPath "/forecasts") and (request.verb = "GET")</Condition>
</Flow>
</Flows>Warunki te oznaczają: „Gdy nadejdzie żądanie GET z /reports i /forecasts w adresie URL, Edge wykona dowolne działanie, które Ty (programista interfejsu API) mu wskażesz, za pomocą zasad, które dołączysz do tych przepływów.
Oto przykład, jak poinformować Edge, co ma zrobić, gdy warunek zostanie spełniony. W poniższym pliku XML serwera proxy interfejsu API, gdy żądanie GET jest wysyłane do https://yourorg-test.apigee.net/mygreatweatherforecast/reports, Edge wykonuje zasadę „XML-to-JSON-1” w odpowiedzi.
<Flows>
<Flow name="reports">
<Description/>
<Request/>
<Response>
<Step>
<Name>XML-to-JSON-1</Name>
</Step>
</Response>
<Condition>(proxy.pathsuffix MatchesPath "/reports") and (request.verb = "GET")</Condition>
</Flow>Oprócz tych opcjonalnych przepływów warunkowych każdy serwer proxy interfejsu API ma też 2 przepływy domyślne: <PreFlow> wykonywany przed przepływami warunkowymi i <PostFlow> wykonywany po przepływach warunkowych. Są one przydatne do wykonywania zasad, gdy wywoływane jest dowolne wywołanie do serwera proxy interfejsu API. Jeśli na przykład chcesz weryfikować klucz interfejsu API aplikacji przy każdym wywołaniu, niezależnie od zasobu backendu, do którego uzyskiwany jest dostęp, możesz umieścić zasadę Verify API Key w <PreFlow>. Więcej informacji o przepływach znajdziesz w artykule o konfigurowaniu przepływów.
tworzyć automatyzacje warunkowe do zasobów backendu,
Definiowanie przepływów warunkowych do zasobów backendu w serwerze proxy interfejsu API jest całkowicie opcjonalne. Te przepływy warunkowe umożliwiają jednak precyzyjne zarządzanie i monitorowanie.
Będziesz mieć możliwość:
- Zastosuj zarządzanie w sposób odzwierciedlający semantykę modelu interfejsu API.
- stosowanie zasad i skryptów do poszczególnych ścieżek zasobów (identyfikatorów URI);
- Zbieranie szczegółowych danych dotyczących usług Analytics
Wyobraź sobie na przykład, że musisz zastosować różne typy logiki do zasobów backendu /developers i /apps.
Aby to zrobić, dodaj do serwera proxy interfejsu API 2 przepływy warunkowe: /developers i /apps.
W widoku Develop (Programowanie) w panelu nawigacji edytora serwerów proxy interfejsu API kliknij ikonę + obok opcji default (domyślny) w sekcji Proxy Endpoints (Punkty końcowe serwera proxy).
![]()
W oknie „New Conditional Flow” (Nowy przepływ warunkowy) wpisz te kluczowe konfiguracje:
- Flow name: Developers
- Typ warunku: Ścieżka
- Ścieżka: /developers

Warunek zostanie aktywowany (a zasady zostaną wykonane), jeśli do serwera proxy zostanie wysłane wywołanie z ciągiem /developers na końcu identyfikatora URI.
Teraz dodaj przepływ warunkowy dla /apps i załóż, że chcesz, aby warunek był aktywowany zarówno przez identyfikator URI, jak i czasownik POST w żądaniu. Konfiguracja obejmuje ustawienie tych elementów:
- Flow Name: Apps
- Typ warunku: ścieżka i czasownik
- Ścieżka: /apps
- Czasownik: POST

Warunek zostanie aktywowany (a zasady zostaną wykonane), jeśli do serwera proxy zostanie wysłane wywołanie z ciągiem /apps na końcu identyfikatora URI i czasownikiem POST.
W panelu nawigatora zobaczysz nowe przepływy dla aplikacji i deweloperów.

Wybierz jeden z przepływów, aby wyświetlić konfigurację przepływu warunkowego w widoku kodu edytora proxy interfejsu API:
<Flow name="Apps"> <Description>Developer apps registered in Developer Services</Description> <Request/> <Response/> <Condition>(proxy.pathsuffix MatchesPath "/apps") and (request.verb = "POST")</Condition> </Flow>
Jak widać, zasoby interfejsu API to po prostu przepływy warunkowe, które oceniają ścieżkę identyfikatora URI żądania przychodzącego. (Zmienna proxy.pathsuffix identyfikuje identyfikator URI żądania, który następuje po BasePath skonfigurowanym w konfiguracji ProxyEndpoint).
Każdy zdefiniowany zasób interfejsu API jest implementowany przez warunkowy przepływ w proxy interfejsu API. (patrz Konfigurowanie przepływów).
Po wdrożeniu serwera proxy interfejsu API w środowisku testowym żądanie:
http://{org_name}-test.apigee.net/{proxy_path}/appsspowoduje, że warunek zostanie oceniony jako prawda, a ten przepływ wraz ze wszystkimi powiązanymi zasadami zostanie wykonany.
W tym przykładowym warunku użyto wyrażenia regularnego Java do rozpoznawania wywołań zasobu /apps z ukośnikiem na końcu lub bez niego (/apps lub /apps/**):
<Condition>(proxy.pathsuffix JavaRegex "/apps(/?)") and (request.verb = "POST")</Condition>
Więcej informacji o tym typie warunku znajdziesz w artykule How to match regardless ... (Jak dopasowywać niezależnie od...) w społeczności Apigee.
Modelowanie hierarchicznych identyfikatorów URI
W niektórych przypadkach zasoby interfejsu API będą miały strukturę hierarchiczną. Na przykład interfejs Developer Services API udostępnia metodę wyświetlania listy wszystkich aplikacji należących do dewelopera. Ścieżka identyfikatora URI:
/developers/{developer_email}/appsMożesz mieć zasoby, w których dla każdej encji w kolekcji generowany jest unikalny identyfikator, który czasami jest oznaczany w następujący sposób:
/genus/:id/species
Ta ścieżka dotyczy obu tych identyfikatorów URI:
/genus/18904/species /genus/17908/species
Aby przedstawić tę strukturę w zasobie interfejsu API, możesz użyć symboli wieloznacznych. Na przykład:
/developers/*/apps
/developers/*example.com/apps
/genus/*/species
będzie odpowiednio rozpoznawać te hierarchiczne identyfikatory URI jako zasoby interfejsu API.
W niektórych przypadkach, zwłaszcza w przypadku interfejsów API o głębokiej hierarchii, możesz po prostu chcieć rozwiązać wszystkie problemy poniżej określonego fragmentu identyfikatora URI. Aby to zrobić, użyj w definicji zasobu symbolu wieloznacznego z podwójną gwiazdką. Jeśli na przykład zdefiniujesz ten zasób interfejsu API:/developers/**
Ten zasób interfejsu API będzie rozpoznawać te ścieżki URI:
/developers/{developer_email}/apps
/developers/{developer_email}/keys
/developers/{developer_email}/apps/{app_id}/keysOto jak wyglądałby warunek przepływu warunkowego w definicji serwera proxy interfejsu API:
<Condition>(proxy.pathsuffix MatchesPath "/developers/**") and (request.verb = "POST")</Condition>
Więcej przykładów
Warunek dołączony do RouteRule
<RouteRule name="default"> <!--this routing executes if the header indicates that this is an XML call. If true, the call is routed to the endpoint XMLTargetEndpoint--> <Condition>request.header.content-type = "text/xml"</Condition> <TargetEndpoint>XmlTargetEndpoint</TargetEndpoint> </RouteRule>
Warunek dołączony do zasady
<Step> <!--the policy MaintenancePolicy only executes if the response status code is exactly 503--> <Condition>response.status.code = 503</Condition> <Name>MaintenancePolicy</Name> </Step>
Przepływ warunkowy
<!-- this entire flow is executed only if the request verb is a GET--> <Flow name="GetRequests"> <Condition>request.verb="GET"</Condition> <Request> <Step> <!-- this policy only executes if request path includes a term like statues--> <Condition>request.path ~ "/statuses/**"</Condition> <Name>StatusesRequestPolicy</Name> </Step> </Request> <Response> <Step> <!-- this condition has multiple expressions. The policy executes if the response code status is exactly 503 or 400--> <Condition>(response.status.code = 503) or (response.status.code = 400)</Condition> <Name>MaintenancePolicy</Name> </Step> </Response> </Flow>
Przykładowe operatory w warunkach
Oto kilka przykładów operatorów używanych do tworzenia warunków:
request.header.content-type = "text/xml"request.header.content-length < 4096 && request.verb = "PUT"response.status.code = 404 || response.status.code = 500request.uri MatchesPath "/*/statuses/**"request.queryparam.q0 NotEquals 10
Praktyczny przykład: ignorowanie znaku „/” na końcu ścieżki
Deweloperzy Edge zwykle chcą obsługiwać oba te sufiksy ścieżki: „/cat” i „/cat/”. Wynika to z tego, że niektórzy użytkownicy lub klienci mogą wywoływać interfejs API z dodatkowym ukośnikiem na końcu ścieżki, a Ty musisz mieć możliwość obsługi tego w instrukcjach warunkowych. Ten konkretny przypadek użycia został omówiony w społeczności Apigee.
Jeśli wolisz, możesz to zrobić bez użycia wyrażeń regularnych, w ten sposób:
<PreFlow name="PreFlow">
<Request>
<Step>
<Condition>((proxy.pathsuffix = "/cat") OR (proxy.pathsuffix = "/cat/")</Condition>
<Name>SomePolicy</Name>
</Step>
</Request>
<Response/>
</PreFlow>To dobra opcja. jest wyraźny i czytelny;
Możesz jednak zrobić to samo za pomocą wyrażenia regularnego, na przykład tak: Nawiasy służą do grupowania części instrukcji zawierającej wyrażenie regularne, ale nie są wymagane.
<Condition>(proxy.pathsuffix JavaRegex "/cat(/?)"</Condition>
Wywołania interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat
or
GET http://artomatic-test.apigee.net/matchtest/cat/
Czy zasada jest wykonywana? Tak. Pamiętaj, że w wyrażeniu regularnym znak „?” oznacza: dopasuj zero lub 1 poprzedni znak. Dlatego pasują zarówno „/cat”, jak i „/cat/”.
Wywołanie interfejsu API:
GET http://artomatic-test.apigee.net/matchtest/cat/spotted
Czy zasada jest wykonywana? Nie. Wyrażenie regularne dopasowuje zero lub tylko jedno wystąpienie poprzedzającego znaku i nic innego nie jest dozwolone.
Dopasowywanie dowolnych ciągów znaków za pomocą JavaRegex
We wszystkich przykładach w tym temacie pokazujemy, jak dopasować jedną z wbudowanych zmiennych przepływu: proxy.pathsuffix. Warto wiedzieć, że dopasowywanie wzorców można wykonywać na dowolnym ciągu znaków lub zmiennej przepływu, niezależnie od tego, czy jest to wbudowana zmienna przepływu, taka jak proxy.pathsuffix.
Jeśli na przykład masz warunek, który sprawdza dowolny ciąg znaków, np. ciąg znaków zwrócony w ładunku backendu lub ciąg znaków zwrócony z wyszukiwania na serwerze uwierzytelniania, możesz użyć operatorów dopasowania, aby go sprawdzić. Jeśli używasz JavaRegex, wyrażenie regularne będzie porównywane z całym ciągiem znaków tematu. Jeśli temat to „abc”, a wyrażenie regularne to „[a-z]”, nie ma dopasowania, ponieważ „[a-z]” pasuje dokładnie do jednego znaku alfabetycznego. Wyrażenie „[a-z]+” działa, podobnie jak „[a-z]*” i „[a-z]{3}.
Przeanalizujmy konkretny przykład. Załóżmy, że serwer uwierzytelniania zwraca listę ról jako ciąg znaków rozdzielonych przecinkami: „editor, author, guest”.
Ta konstrukcja nie sprawdzi się do testowania obecności roli edytującego, ponieważ „edytujący” to tylko część całego ciągu znaków.
<Condition>returned_roles ~~ "editor"</Condition>
Jednak ta konstrukcja będzie działać:
<Condition>returned_roles ~~ ".*\beditor\b.*")</Condition>
Działa, ponieważ uwzględnia podziały wyrazów i inne części ciągu znaków z prefiksem i sufiksem .*.
W tym przykładzie możesz też sprawdzić, czy występuje słowo „editor”, używając operatora Matches:
<Condition>returned_roles ~~ "*editor*")</Condition>
Jeśli jednak potrzebujesz większej precyzji, często lepszym wyborem jest JavaRegex.
Używanie znaku zmiany znaczenia w przypadku cudzysłowów w wyrażeniach JavaRegex
Składnia warunku wymaga, aby wyrażenie JavaRegex było ujęte w cudzysłów. Jeśli więc masz wyrażenie regularne, które zawiera cudzysłów, musisz znaleźć inny sposób na jego dopasowanie. Odpowiedź to Unicode. Załóżmy na przykład, że przekazujesz nagłówek zawierający cudzysłowy, taki jak ten:-H 'content-type:multipart/related; type="application/xop+xml"'
request.header.Content-Type ~~ "(multipart\/related)(; *type="application\/xop\+xml\")"
\u0022. Na przykład to wyrażenie jest prawidłowe i daje oczekiwany wynik:
request.header.Content-Type ~~ "(multipart\/related)(; *type=\u0022application\/xop\+xml\u0022)"