Dokumentacja konfiguracji przepływu współdzielonego

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
Informacje

Przepływ udostępniony to funkcja wielokrotnego użytku podobna do serwera proxy interfejsu API. Większość treści w tym dokumencie będzie znajoma, jeśli znasz już serwery proxy API.

Jeśli uczysz się, jak utworzyć udostępniony przepływ, zacznij od tematu Udostępnione przepływy wielokrotnego użytku.

Struktura pakietu przepływu współdzielonego

Wspólny pakiet przepływu ma taką konfigurację:

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 DDEX, do których odnoszą się zasady w celu wykonania niestandardowej logiki. Zobacz Zasoby.
SharedFlows Przepływy współdzielone zawarte w tym pakiecie. Zobacz Przepływy współdzielone.

Komponenty w tabeli powyżej są zdefiniowane w plikach konfiguracji w tej strukturze katalogów:

Pliki konfiguracji i struktura katalogów pakietu wspólnego procesu

W tej sekcji opisano pliki konfiguracji i strukturę katalogów wspólnego pakietu przepływów.

Konfiguracja podstawowa

Podstawowy plik konfiguracji znajduje się w głównym katalogu pakietu. Jej nazwa to nazwa pakietu.

/sharedflowbundle/traffic-management-shared.xml

Konfiguracja podstawowa określa zawartość udostępnionego pakietu przepływu pracy oraz informacje na temat śledzenia historii zmian tego 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ślne Wymagana?
SharedFlowBundle
name Nazwa udostępnionego pakietu przepływów, która musi być niepowtarzalna w organizacji. Dozwolone są tylko te znaki: A-Za-z0-9_- Nie dotyczy Tak
revision Numer wersji konfiguracji wspólnego pakietu przepływu pracy. Nie musisz wyraźnie ustawiać numeru wersji, ponieważ Apigee Edge automatycznie śledzi bieżącą wersję przepływu współdzielonego. Nie dotyczy Nie

Podstawowe elementy konfiguracji

Nazwa Opis Domyślne Wymagana?
SharedFlowBundle
ConfigurationVersion Wersja schematu konfiguracji udostępnionego pakietu przepływów, z którą zgodny jest ten przepływ. Obecnie jedyną obsługiwaną wartością jest wersja majorVersion 4 i childVersion 0. W przyszłości można użyć tego ustawienia, aby umożliwić ewolucję formatu wspólnego pakietu przepływu pracy. 4.0 Nie
CreatedAtCreatedBy Data i godzina (w czasie epoki) utworzenia wspólnego pakietu przepływu wraz z adresem e-mail użytkownika, który go utworzył.
Description Tekstowy opis udostępnionego procesu. Jeśli zostanie podany, opis pojawi się w interfejsie zarządzania brzegiem. Nie dotyczy Nie
DisplayName Przyjazna dla użytkownika nazwa, która może różnić się od atrybutu name współdzielonej konfiguracji przepływu. Nie dotyczy Nie
LastModifiedAtLastModifiedBy Data i godzina (w czasie Epoki) ostatniej modyfikacji udostępnionego pakietu przepływu pracy wraz z adresem e-mail użytkownika, który go zmodyfikował.
Policies Lista zasad w katalogu /policies tego udostępnionego przepływu. Zwykle ten element pojawia się tylko wtedy, gdy przepływ udostępniony został utworzony za pomocą interfejsu zarządzania brzegiem. Jest to ustawienie tylko w pliku manifestu, które zapewnia wgląd w zawartość udostępnianego przepływu. Nie dotyczy Nie
Resources Lista zasobów (JavaScript, Python, Java, Spanner) w katalogu /resources tego udostępnionego procesu. Zwykle ten element pojawia się tylko wtedy, gdy przepływ udostępniony został utworzony za pomocą interfejsu zarządzania brzegiem. Jest to ustawienie tylko w pliku manifestu, które zapewnia wgląd w zawartość udostępnionego przepływu. Nie dotyczy Nie
SharedFlows Określa przepływ udostępniania zawarty w pakiecie.

Pamiętaj, że obecnie ten element obsługuje tylko jeden element podrzędny <SharedFlow>. Do udostępnianego pakietu przepływu można dodać tylko jeden przepływ udostępniony.

Nie dotyczy Tak

Przepływy współdzielone

/sharedflowbundle/sharedflows/default.xml

Konfiguracja ShareFlow określa kolejność, w jakiej mają być wykonywane elementy przepływu. Elementy podrzędne <Step> elementu <SharedFlow> określają część sekwencji, na przykład wywołanie zasady.

Poniższa konfiguracja ShareFlow określa 3 zasady do wykonania w sekwencji od góry do dołu (od lewej do prawej w konsoli zarządzania), przy czym zasada aresztowania Spike i zasada wywołania przepływu na końcu.

<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 przepływu współdzielonego

Nazwa Opis Domyślne Wymagana?
SharedFlow
name Nazwa udostępnionego procesu, która musi być niepowtarzalna w obrębie organizacji. Dozwolone są tylko te znaki: A-Za-z0-9_- Nie dotyczy Tak
revision Numer wersji udostępnionej konfiguracji przepływu. Nie musisz wyraźnie ustawiać numeru wersji, ponieważ Apigee Edge automatycznie śledzi bieżącą wersję przepływu współdzielonego. Nie dotyczy Nie

Elementy konfiguracji przepływu współdzielonego

Nazwa Opis Domyślne Wymagana?
SharedFlow Określa sekwencję zasad we wspólnym przepływie. Nie dotyczy Tak
Step Definiuje 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 nazwy zasady. Nie dotyczy Tak

Zasady

/sharedflowbundle/policies

Tak jak w przypadku serwera proxy interfejsu API, w pakiecie udostępnianego procesu katalog /policies zawiera kod XML konfiguracji wszystkich zasad, które można dołączyć do udostępnionego przepływu w pakiecie. Zasady współdzielą podzbiór elementów, choć ten podzbiór jest uzupełniony o elementy specyficzne dla danej zasady. Więcej informacji o konfigurowaniu zasady znajdziesz w temacie dotyczącym wybranej zasady. Znajdziesz je też w omówieniu informacji o zasadach.

Zasoby

/sharedflowbundle/resources

Zasoby to skrypty, kod i przekształcenia XSL, które można dołączyć do udostępnionych przepływów za pomocą zasad. Pojawiają się one w sekcji Skrypty w edytorze przepływu współdzielonego w interfejsie zarządzania.

Listę obsługiwanych typów zasobów znajdziesz w sekcji Pliki zasobów.

Zadaj pytania na forum dla programistów Apigee.