Czym są zasady?

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Apigee Edge umożliwia „programowanie” zachowanie interfejsu API bez konieczności pisania kodu przez użycie „zasady”. Zasada jest jak moduł, który wdraża określoną, ograniczoną funkcję zarządzania. Zasady zostały zaprojektowane tak, aby umożliwić łatwe dodawanie do interfejsu API typowych typów funkcji zarządzania niezawodnie. Zasady zapewniają takie funkcje jak bezpieczeństwo, ograniczanie liczby żądań, przekształcanie i zapośredniczenie. dzięki czemu nie musisz pisać kodu i samodzielnie zarządzać tymi funkcjami.

Nie musisz ograniczać się do zestawu typów zasad udostępnianych przez Apigee Edge. Możesz też pisać niestandardowe skrypty i kod (np. aplikacje JavaScript i Node.js), które rozszerzają funkcjonalność proxy API i umożliwiają wprowadzanie innowacji na poziomie podstawowych funkcji zarządzania obsługiwanych przez Apigee Policies.

Typy zasad

Zasady to plik konfiguracji w formacie XML. Struktura każdego typu zasad (na przykład wymagane i opcjonalne elementy konfiguracji) są zdefiniowane przez schemat XML. Jeśli potrafisz obsługiwać narzędzia XML, zapoznaj się ze schematami zasad w przykładach platformy interfejsów API w GitHubie.

Typy zasad brzegowych są podzielone na te kategorie funkcjonalne:

Zarządzanie ruchem

Zasady w kategorii zarządzania ruchem pozwalają kontrolować przepływ żądań oraz z odpowiedziami przez serwer proxy interfejsu API. Te zasady są zgodne zarówno z kontrolę na poziomie firmy. Pozwalają kontrolować nieprzetworzoną przepustowość oraz ruch w przypadku każdej aplikacji. Typy zasad zarządzania ruchem umożliwiają egzekwowanie limitów oraz mogą pomóc w zmniejszeniu liczby ataków typu DoS.

Bezpieczeństwo

Zasady w kategorii bezpieczeństwa umożliwiają uwierzytelnianie, autoryzację oraz zabezpieczenia oparte na treściach.

Mediacja

Zasady w kategorii zapośredniczenia umożliwiają aktywne manipulowanie wiadomościami podczas ich przekazywania przez serwery proxy interfejsu API. Umożliwiają przekształcanie formatów wiadomości, z XML-a na JSON (oraz i odwrotnie) lub przekształcenie jednego formatu XML na inny. Umożliwiają też analizowanie wiadomości w celu generowania nowych wiadomości oraz zmieniania wartości wiadomości wychodzących. Mediacja zasady współdziałają też z podstawowymi usługami udostępnianymi przez usługi API, umożliwiając informacje o aplikacjach, programistach, tokenach bezpieczeństwa i usługach API w czasie działania.

Rozszerzenie

Zasady w kategorii rozszerzeń pozwalają korzystać z możliwości rozszerzania usług API, aby zaimplementować niestandardowe zachowanie w wybranym języku programowania.

Każdy typ zasad jest szczegółowo udokumentowany w artykule Omówienie informacji o zasadach. W tym temacie omawiamy ogólne zagadnienia i omawiamy, jak tworzyć zasady oraz jak dołączają je do przepływów w konfiguracji serwera proxy interfejsu API.

Wdrażam zmiany zasad

Aby zmiany zasad zaczęły obowiązywać, musisz wdrożyć w środowisku wersję serwera proxy interfejsu API. Po dołączeniu zasad lub wprowadzeniu zmian w istniejących zasadach skorzystaj z interfejsu zarządzania lub do zarządzania interfejsami API, aby wdrożyć zmiany.

Weryfikacja egzekwowania zasad

Aby sprawdzić, czy zasada jest prawidłowo egzekwowana, klient HTTP musi wywołać interfejs API. Do sprawdzenie konfiguracji limitów, przesłanie wielu żądań do interfejsu API, przekroczenie limitu ustawiony w zasadzie limitów. (Ścieżka identyfikatora URI skonfigurowana jako ustawienie ścieżki podstawowej w ProxyEndpoint w poniższym żądaniu to /weather).

http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282

Jeśli w ciągu minuty prześlesz więcej niż 1 prośbę, powinien pojawić się ten błąd: wiadomość:

{  
   "fault":{  
      "faultstring":"policies.ratelimit.QuotaViolation",
      "detail":{  
         "errorcode":"policies.ratelimit.QuotaViolation"
      }
   }
}

Oznacza to, że zasady dotyczące limitów są egzekwowane przez usługi interfejsu API.

Oparta na zasadach obsługa błędów

Zwróć uwagę na format komunikatu o błędzie powyżej. Zawiera właściwość faultstring i usłudze errorcode. W wielu przypadkach musisz zastosować pewne zachowania, naprawiania tych błędów. Na przykład możesz wysłać dostosowaną wiadomość deweloperowi, aplikacja przekroczyła limit.

Więcej informacji o usuwaniu awarii znajdziesz w tej sekcji.

Sprawdzone metody: typowe zestawy zasad

Aby spełnić podstawowe wymagania dotyczące zarządzania, serwery proxy interfejsów API zwykle wymuszają następujące zasady:

Podstawowy klucz interfejsu API weryfikacja

Przepływ żądania ProxyEndpoint:

1. SpikeArrest
2. XMLThreatProtection lub JSONThreatProtection
3. Weryfikacja klucza interfejsu API
4. Limit
5. ResponseCache

Przepływ odpowiedzi punktu końcowego serwera proxy:

1. ResponseCache

Podstawowe przekształcenie: JSON na XML

Proces wysyłania żądań:

1. SpikeArrest
2. JSONThreatProtection
3. Weryfikacja klucza interfejsu API
4. Limit
5. JSONToXML

Przebieg odpowiedzi:

1. Plik XML do JSON
2. ResponseCache