Dodawanie buforowania w celu poprawy wydajności usługi Azure API Management

  • Artykuł

DOTYCZY: Developer | Podstawowa | Podstawowa wersja 2 | Standardowa | Standardowa, wersja 2 | Premium

Interfejsy API i operacje w usłudze API Management można skonfigurować przy użyciu buforowania odpowiedzi. Buforowanie odpowiedzi może znacznie zmniejszyć opóźnienia wywołań interfejsu API i ładowania zaplecza dla dostawców interfejsów API.

Ważne

Wbudowana pamięć podręczna jest niestabilna i współużytkowana przez wszystkie jednostki w tym samym regionie w tej samej usłudze API Management. Niezależnie od używanego typu pamięci podręcznej (wewnętrzna lub zewnętrzna), jeśli operacje związane z pamięcią podręczną nie mogą nawiązać połączenia z pamięcią podręczną z powodu jej nietrwałości lub innej przyczyny, wywołanie interfejsu API używające operacji związanej z pamięcią podręczną nie zgłasza błędu i operacja pamięci podręcznej kończy się pomyślnie. W przypadku operacji odczytu zwracana jest wartość null do wywołującego wyrażenia zasad. Kod zasad powinien być zaprojektowany w celu zapewnienia, że w pamięci podręcznej istnieje mechanizm "rezerwowy" umożliwiający pobieranie danych. Aby uzyskać bardziej szczegółowe informacje na temat buforowania, zobacz Zasady buforowania w usłudze API Management i Buforowanie niestandardowe w usłudze Azure API Management.

zasady buforowania

Zawartość:

  • Dodawanie buforowania odpowiedzi do interfejsu API
  • Sprawdzanie działania buforowania

Uwaga

Wewnętrzna pamięć podręczna nie jest dostępna w warstwie Zużycie usługi Azure API Management. Zamiast tego można użyć zewnętrznej pamięci podręcznej Azure Cache for Redis. Możesz również skonfigurować zewnętrzną pamięć podręczną w innych warstwach usługi API Management.

Wymagania wstępne

W celu ukończenia tego samouczka:

Dodawanie zasad buforowania

W zasadach buforowania pokazanych w tym przykładzie pierwsze żądanie operacji GetSpeakers zwraca odpowiedź z usługi zaplecza. Ta odpowiedź jest zbuforowana z kluczem uwzględniającym określone nagłówki i parametry ciągu zapytania. Dla kolejnych wywołań operacji z pasującymi parametrami będą zwracana buforowaną odpowiedź do czasu wygaśnięcia interwału czasu trwania pamięci podręcznej.

  1. Zaloguj się w witrynie Azure Portal.

  2. Przejdź do swojego wystąpienia usługi APIM.

  3. Wybierz kartę API.

  4. Kliknij pozycję Demo Conference API (Pokazowy interfejs API konferencji) na liście interfejsów API.

  5. Wybierz operację GetSpeakers.

  6. W górnej części ekranu wybierz kartę Projektowanie.

  7. W sekcji Przetwarzanie przychodzące kliknij ikonę </>.

    edytor kodu

  8. W elemencie inbound (przychodzące) dodaj następujące zasady:

    <cache-lookup vary-by-developer="false" vary-by-developer-groups="false">
    <vary-by-header>Accept</vary-by-header>
    <vary-by-header>Accept-Charset</vary-by-header>
    <vary-by-header>Authorization</vary-by-header>
</cache-lookup>

  9. W elemencie outbound (wychodzące) dodaj następujące zasady:

    <cache-store duration="20" />

    Czas trwania określa interwał wygasania buforowanych odpowiedzi. W tym przykładzie interwał to 20 sekund.

Napiwek

Jeśli używasz zewnętrznej pamięci podręcznej zgodnie z opisem w temacie Używanie zewnętrznej pamięci podręcznej Azure Cache for Redis w usłudze Azure API Management, warto określić atrybut caching-type zasad buforowania. Zobacz Zasady buforowania usługi API Management, aby uzyskać więcej informacji.

Wywoływanie operacji i testowanie buforowania

Wywołaj operację z portalu dla deweloperów, aby sprawdzić działanie buforowania.

  1. W portalu Azure przejdź do swojego wystąpienia usługi APIM.
  2. Wybierz kartę Interfejsy API.
  3. Wybierz interfejs API, do którego dodano zasady buforowania.
  4. Wybierz operację GetSpeakers.
  5. Kliknij kartę Test w prawym górnym menu.
  6. Kliknij pozycję Wyślij.

Następne kroki