Dokumentacja konfiguracji przepływu współdzielonego

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Współdzielony przepływ to funkcja wielokrotnego użytku podobna do proxy interfejsu API. Jeśli znasz już proxy interfejsu API, większość treści w tym dokumencie będzie Ci znana.

Jeśli uczysz się, jak tworzyć współdzielony przepływ, zacznij od tematu Współdzielone przepływy wielokrotnego użytku.

Struktura pakietu współdzielonego przepływu

Pakiet współdzielonego przepływu składa się z tych konfiguracji:

Konfiguracja podstawowa Podstawowe ustawienia konfiguracji. Zobacz Konfiguracja podstawowa.
Zasady Pliki konfiguracji w formacie XML zgodne ze schematami zasad Apigee Edge. Zobacz Zasady.
Materiały Skrypty, pliki JAR i pliki XSLT, do których odwołują się zasady w celu wykonania niestandardowej logiki. Zobacz Materiały.
SharedFlows Przepływy współdzielone zawarte w tym pakiecie. Zobacz Przepływy współdzielone.

Komponenty w tabeli powyżej są definiowane przez pliki konfiguracji w tej strukturze katalogów:

Pliki konfiguracji i struktura katalogów pakietu współdzielonego przepływu

W tej sekcji opisujemy pliki konfiguracji i strukturę katalogów pakietu współdzielonego przepływu.

Konfiguracja podstawowa

Podstawowy plik konfiguracji znajduje się w katalogu głównym pakietu. Jego nazwa jest taka sama jak nazwa pakietu.

/sharedflowbundle/traffic-management-shared.xml

Konfiguracja podstawowa określa zawartość pakietu współdzielonego przepływu oraz informacje do śledzenia historii zmian pakietu.

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

Atrybuty konfiguracji podstawowej

Nazwa Opis Domyślny Wymagany?
SharedFlowBundle
name Nazwa pakietu współdzielonego przepływu, która musi być unikalna w organizacji. W nazwie można używać tylko tych znaków: A-Za-z0-9_- Nie dotyczy Tak
revision Numer wersji konfiguracji pakietu współdzielonego przepływu. Nie musisz jawnie ustawiać numeru wersji, ponieważ Apigee Edge automatycznie śledzi bieżącą wersję współdzielonego przepływu. Nie dotyczy Nie

Elementy konfiguracji podstawowej

Nazwa Opis Domyślny Wymagany?
SharedFlowBundle
ConfigurationVersion Wersja schematu konfiguracji pakietu współdzielonego przepływu, z którym jest zgodny ten współdzielony przepływ Obecnie obsługiwana jest tylko wersja główna 4 i wersja podrzędna 0. To ustawienie może być w przyszłości używane do umożliwienia ewolucji formatu pakietu współdzielonego przepływu. 4.0 Nie
CreatedAt i CreatedBy Data i godzina (w formacie epoch time) utworzenia pakietu współdzielonego przepływu oraz adres e-mail użytkownika, który go utworzył.
Description Opis tekstowy przepływu współdzielonego. Jeśli podasz opis, będzie on wyświetlany w interfejsie zarządzania Edge. Nie dotyczy Nie
DisplayName Nazwa przyjazna dla użytkownika, która może się różnić od wartości atrybutu name konfiguracji współdzielonego przepływu. Nie dotyczy Nie
LastModifiedAt i LastModifiedBy Data i godzina (w formacie epoch time) ostatniej modyfikacji pakietu współdzielonego przepływu oraz adres e-mail użytkownika, który go zmodyfikował.
Policies Lista zasad w katalogu /policies tego współdzielonego przepływu. Ten element zwykle pojawia się tylko wtedy, gdy współdzielony przepływ został utworzony za pomocą interfejsu zarządzania Edge. Jest to po prostu ustawienie „manifestu”, które ma na celu zapewnienie wglądu w zawartość przepływu współdzielonego. Nie dotyczy Nie
Resources Lista zasobów (JavaScript, Python, Java, XSLT) w katalogu /resources tego współdzielonego przepływu. Ten element zwykle pojawia się tylko wtedy, gdy współdzielony przepływ został utworzony za pomocą interfejsu zarządzania Edge. Jest to po prostu ustawienie „manifestu”, które ma na celu zapewnienie wglądu w zawartość przepływu współdzielonego. Nie dotyczy Nie
SharedFlows Określa przepływ współdzielony, który zawiera ten pakiet.

Pamiętaj, że obecnie ten element obsługuje tylko 1 element podrzędny <SharedFlow>. Do pakietu przepływu współdzielonego można dodać tylko 1 przepływ współdzielony.

 Nie dotyczy Tak

Przepływy współdzielone

/sharedflowbundle/sharedflows/default.xml

Konfiguracja SharedFlow określa kolejność wykonywania elementów przepływu. Każdy element podrzędny <Step> elementu <SharedFlow> określa część sekwencji, np. wywołanie zasady.

Ta konfiguracja SharedFlow określa 3 zasady, które mają być wykonywane w kolejności od góry do dołu (od lewej do prawej w konsoli zarządzania), przy czym pierwsza jest zasada Spike Arrest, a ostatnia – zasada Flow Callout.

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

Atrybuty konfiguracji współdzielonego przepływu

Nazwa Opis Domyślny Wymagany?
SharedFlow
name Nazwa współdzielonego przepływu, która musi być unikalna w organizacji. W nazwie można używać tylko tych znaków: A-Za-z0-9_- Nie dotyczy Tak
revision Numer wersji konfiguracji współdzielonego przepływu. Nie musisz jawnie ustawiać numeru wersji, ponieważ Apigee Edge automatycznie śledzi bieżącą wersję współdzielonego przepływu. Nie dotyczy Nie

Elementy konfiguracji współdzielonego przepływu

Nazwa Opis Domyślny Wymagany?
SharedFlow Określa kolejność zasad w przepływie współdzielonym. Nie dotyczy Tak
Step Określa krok – etap w sekwencji przepływu. Nie dotyczy Tak
Name Określa nazwę elementu, do którego odwołuje się krok. Wartość tego elementu powinna być taka sama jak unikalny identyfikator elementu, np. wartość atrybutu name zasady. Nie dotyczy Tak

Zasady

/sharedflowbundle/policies

Podobnie jak w przypadku proxy interfejsu API, w pakiecie współdzielonego przepływu katalog /policies zawiera konfigurację XML wszystkich zasad, które można dołączyć do współdzielonego przepływu w pakiecie. Zasady mają wspólny podzbiór elementów, ale ten podzbiór jest uzupełniany o elementy, które są specyficzne dla danej zasady. Więcej informacji o konfigurowaniu zasady znajdziesz w temacie dotyczącym danej zasady. Możesz też przejść do tych informacji z sekcji Omówienie dokumentacji zasad.

Materiały

/sharedflowbundle/resources

Materiały to skrypty, kod i transformacje XSL, które można dołączyć do przepływów współdzielonych za pomocą zasad. Pojawiają się one w sekcji Skrypty edytora współdzielonego przepływu w interfejsie zarządzania UI.

Obsługiwane typy materiałów znajdziesz w artykule Pliki materiałów.

Zadawaj pytania na forum dla programistów Apigee.