Dołączanie udostępnionego przepływu za pomocą punktu zaczepienia przepływu

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
Informacje

W ramach wspólnych przepływów możesz wykonywać wstępne przetwarzanie żądań i post-processing odpowiedzi w zbiorze interfejsów API. Za pomocą haka przepływu możesz dołączyć udostępniony przepływ, aby wykonywał się w tym samym miejscu we wszystkich interfejsach API wdrożonych w określonym środowisku. Dzięki temu masz oddzielnie zaimplementowaną i wdrożona sekwencję logiki, która nie jest częścią kodu implementacji serwera proxy.

Kod dołączony do haka przepływu jest poza kontekstem głównej logiki interfejsu API, więc jego działanie różni się od działania interfejsów API. O czym musisz pamiętać:

  • Aby dołączyć przepływ współdzielony do punktu zaczepienia przepływu, musisz mieć odpowiednie uprawnienia. Musisz być administratorem organizacji.
  • Do każdego punktu zaczepienia przepływów możesz dołączyć tylko 1 przepływ współdzielony.
  • Możesz dołączyć ten sam udostępniony przepływ do wielu elementów sterujących przepływem.
  • Jeśli udostępniony przepływ danych dołączony do haka przepływu spowoduje błąd lub wystąpią błędy podczas jego wykonywania, wiadomość zostanie odrzucona, a błąd zostanie wysłany z powrotem do wywołującego.
  • Jeśli wiadomość zostanie odrzucona podczas wykonywania haka przepływu, szczegóły zostaną zapisane w analityce w kontekście wywołanej usługi zastępczej. Udostępniony przepływ może też wywołać błąd z niestandardowym kodem i komunikatem o błędzie.

Ten film pokazuje, jak połączyć wspólny przepływ danych z elementem sterującym przepływu danych, a następnie go prześledzić w interfejsie klasycznej wersji Edge.

Ten film pokazuje, jak połączyć wspólny przepływ danych z elementem sterującym przepływu danych, a następnie go prześledzić w interfejsie użytkownika nowej wersji Edge.

Przepływ współdzielony dołączony do serwera proxy za pomocą punktu zaczepienia przepływu to świetne miejsce na logikę, która zapewnia ogólne wymagania dotyczące zasad. Załóżmy na przykład, że masz jeden zespół zarządzający jednym zestawem wymagań dotyczących zabezpieczeń dla wielu zespołów reprezentujących różne linie biznesowe (LOB). Każdy zespół LOB może tworzyć interfejsy API zgodnie ze swoimi wymaganiami, bez konieczności uwzględniania szerszych wymagań dotyczących bezpieczeństwa. Zespół ds. bezpieczeństwa może wdrożyć te wymagania dotyczące zabezpieczeń w ramach wspólnego procesu, a następnie dołączyć ten proces do środowiska Apigee Edge za pomocą elementu łącznika procesu. Ponieważ wspólny przepływ danych nie jest częścią kodu proxy, zespół ds. bezpieczeństwa może go w razie potrzeby zmodyfikować, nie wpływając na kod LOB.

Wspólne przepływy danych dołączone za pomocą haka przepływu danych są wykonywane w tym miejscu w przypadku każdego proxy interfejsu API wdrożonego w środowisku haka proxy. Z tego powodu możliwość korzystania z haczyków przepływu jest dostępna tylko dla administratorów organizacji Apigee Edge.

Więcej informacji o wspólnych przepływach danych znajdziesz w artykule Wielokrotne używanie wspólnych przepływów danych.

Za pomocą konsoli zarządzania Apigee Edge możesz dołączyć wspólny przepływ danych do haka przepływu. Do punktu zaczepienia przepływów możesz dołączyć maksymalnie 1 przepływ współdzielony w jednym z tych miejsc:

  • Przed serwerem proxy Hook przepływu – służy do logiki, która musi być stosowana PRZED wykonaniem punktu końcowego serwera proxy.

    Możesz na przykład mieć logikę na potrzeby wymuszania zabezpieczeń we wszystkich interfejsach API w danym środowisku.

  • Przedprzewodnik po przepływie danych przed docelowym elementem – służy do logiki, która musi być stosowana PRZED wywołaniem docelowego elementu.

    Możesz na przykład wdrożyć logowanie, zanim żądanie dotrze do backendu. Możesz też wymusić udział pośrednika, usuwając z prośby niektóre pola.

  • Element skoku do kodu po docelowym przepływie danych – służy do logiki, która musi być wykonywana PO wykonaniu docelowej odpowiedzi.

    Zostanie to wymuszone zaraz po otrzymaniu odpowiedzi z back-endu. Możesz go używać do rejestrowania odpowiedzi backendu lub do zapośredniczenia, usuwając z niego pola zawierające dane wrażliwe.

  • Pętla przepływu danych po serwerze proxy – służy do implementowania logiki, która musi być wykonywana PO zakończeniu działania punktu końcowego proxy i zaraz przed wysłaniem odpowiedzi do klienta.

    Może to obejmować logikę egzekwowania CORS, rejestrowanie odpowiedzi lub wykonanie pewnego rodzaju mashupu lub formatowania.

Dołączanie przepływu współdzielonego do punktu zaczepienia przepływów

Aby dołączyć udostępniony przepływ do haka przepływu, musisz być administratorem w organizacji zawierającej udostępniony przepływ.

  1. Otwórz stronę Elementy przepływu danych w opisany niżej sposób.

    Edge

    Aby otworzyć stronę Elementy przepływu za pomocą interfejsu Edge:

    1. Zaloguj się na stronie apigee.com/edge.
    2. Wybierz organizację zawierającą udostępniony proces. Zobacz artykuł Przenoszenie organizacji.

      Przepływ współdzielony będzie dostępny dla wszystkich interfejsów API i przepływów współdzielonych wdrożonych w środowisku tej organizacji. Nie będzie ona dostępna poza tą organizacją.

    3. Na pasku nawigacyjnym po lewej stronie kliknij Administracja > Środowiska > Elementy sterujące przepływu.

    Classic Edge (Private Cloud)

    Aby otworzyć stronę Elementy przepływu w klasycznym interfejsie Edge:

    1. Zaloguj się na stronie http://ms-ip:9000, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania.
    2. Wybierz organizację zawierającą udostępniony proces. Zobacz artykuł Przenoszenie organizacji.

      Przepływ współdzielony będzie dostępny dla wszystkich interfejsów API i przepływów współdzielonych wdrożonych w środowisku tej organizacji. Nie będzie ona dostępna poza tą organizacją.

    3. Na górnym pasku nawigacyjnym kliknij Interfejsy API > Konfiguracja środowiska > Elementy przepływu.
  2. Na liście elementów sterujących przepływem określ element sterujący przepływem, do którego chcesz dołączyć udostępniony przepływ, w zależności od tego, gdzie ma być wykonywany.
    Lokalizacja haka przepływu Opis
    Przedproxy Flow Hook PRZED wykonaniem punktu końcowego serwera proxy
    Przedcelowy uchwyt w schemacie PRZED wykonaniem docelowego punktu końcowego
    Element Hooks w sekcji Po wybraniu celu PO wykonaniu docelowej odpowiedzi
    Hook po przejściu przez serwer proxy PO punkcie końcowym proxy i zaraz przed wysłaniem odpowiedzi do klienta
  3. Umieść kursor na liście nad elementem przepływu, aby wyświetlić kolumnę działań.
  4. Kliknij .
  5. W oknie Przepływ współdzielony wybierz przepływ współdzielony, który chcesz dołączyć, w menu Przepływ współdzielony.
  6. Kliknij OK.
  7. W razie potrzeby dołącz przepływy współdzielone do innych punktów zaczepienia przepływów.