Dokumentacja konfiguracji przepływu współdzielonego

Oglądasz dokumentację Apigee Edge.
Wyświetl dokumentację Apigee X.

Przepływ udostępniony to funkcja wielokrotnego użytku działająca podobnie do serwera proxy interfejsu API. Znaczna część tego pliku referencyjnego będzie znajoma, jeśli dobrze znasz serwery proxy interfejsu API.

Jeśli chcesz się dowiedzieć, jak utworzyć udostępniony przepływ, zacznij od tematu Przepływy współdzielone wielokrotnego użytku.

Struktura pakietów przepływu współdzielonego

Udostępniony pakiet przepływu składa się z tej konfiguracji:

Konfiguracja podstawowa Ustawienia konfiguracji podstawowej. Zobacz Konfiguracja podstawowa.
Zasady Pliki konfiguracji w formacie XML zgodne ze schematami zasad Apigee Edge. Zobacz Zasady.
Materiały Skrypty, pliki JAR i pliki KML, do których odwołują się zasady, aby wykonać logikę niestandardową. Zobacz Zasoby.
Sharedflows, Przepływy wchodzące w skład tego pakietu. Zobacz Przepływy współdzielone.

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

Pliki konfiguracji i struktura katalogu współdzielonego pakietu przepływu

Ta sekcja zawiera omówienie plików konfiguracji i struktury katalogów współdzielonego przepływu przepływu.

Konfiguracja podstawowa

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

/sharedflowbundle/traffic-management-shared.xml

Konfiguracja podstawowa określa zawartość pakietu przepływu współdzielonego wraz z informacjami o śledzeniu 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ślna Wymagana?
SharedFlowBundle
name Nazwa pakietu przepływu współdzielonego, która musi być niepowtarzalna w organizacji. W nazwie możesz używać następujących znaków: A-Za-z0-9_- Nie dotyczy Tak
revision Numer wersji konfiguracji pakietu współdzielonego. Nie musisz jednoznacznie ustawiać numeru wersji, ponieważ Apigee Edge automatycznie śledzi bieżącą wersję przepływu współdzielonego. Nie dotyczy Nie

Elementy konfiguracji podstawowej

Nazwa Opis Domyślna Wymagana?
SharedFlowBundle
ConfigurationVersion Wersja schematu konfiguracji przepływu współdzielonego, z którym jest zgodny ten przepływ udostępniony. Obecnie jedyną obsługiwaną wartością jest mainVersion 4 i versionVersion 0. To ustawienie może być użyte w przyszłości, aby umożliwić rozwijanie formatu pakietu przepływu współdzielonego. 4.0 Nie
CreatedAt i CreatedBy Data/godzina (w czasie epoki) utworzenia pakietu pakietów wraz z e-mailem użytkownika, który je utworzył.
Description Tekstowy opis udostępnionego przepływu. Jeśli zostanie podany, opis będzie wyświetlany w interfejsie zarządzania Edge. Nie dotyczy Nie
DisplayName Przyjazna dla użytkownika nazwa może być inna niż atrybut name w konfiguracji przepływu współdzielonego. Nie dotyczy Nie
LastModifiedAt i LastModifiedBy Data/godzina (w czasie epoki) ostatniej modyfikacji udostępnianego pakietu wraz z adresem e-mail użytkownika, który ją wprowadził.
Policies Lista zasad w katalogu /policies tego przepływu współdzielonego. Ten element jest zwykle widoczny tylko wtedy, gdy proces udostępniania został utworzony w interfejsie zarządzania Edge. Jest to po prostu ustawienie „manifest”, które ma zapewnić wgląd w zawartość przepływu współdzielonego. Nie dotyczy Nie
Resources Lista zasobów (JavaScript, Python, Java, KML) w katalogu /resources tego przepływu współdzielonego. Ten element jest zwykle widoczny tylko wtedy, gdy proces udostępniania został utworzony w interfejsie zarządzania urządzeniami brzegowymi. Jest to po prostu ustawienie „manifest”, które ma zapewnić wgląd w zawartość przepływu współdzielonego. Nie dotyczy Nie
SharedFlows Określa udostępniony przepływ, który zawiera ten pakiet.

Ten element obsługuje obecnie tylko 1 element podrzędny <SharedFlow>. Do pakietu przepływu współdzielonego można dodać tylko 1 przepływ udostępniony.

 Nie dotyczy Tak

Przepływy współdzielone

/sharedflowbundle/sharedflows/default.xml

Konfiguracja SharedFlow definiuje sekwencję, w której mają być wykonywane elementy przepływu. Elementy <Step> elementu <SharedFlow> określają część sekwencji, np. wywołanie zasady.

Poniższa konfiguracja SharedFlow określa 3 zasady do wykonania w kolejności od góry do dołu (od lewej do prawej w konsoli zarządzania), z zasadami Spike Arrest i zasadami 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 przepływu współdzielonego

Nazwa Opis Domyślna Wymagana?
SharedFlow
name Nazwa przepływu współdzielonego, który musi być unikalny w obrębie organizacji. W nazwie możesz używać następujących znaków: A-Za-z0-9_- Nie dotyczy Tak
revision Numer wersji konfiguracji przepływu współdzielonego. Nie musisz ustawiać konkretnego 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ślna Wymagana?
SharedFlow Określa sekwencję zasad w udostępnionym procesie. Nie dotyczy Tak
Step Definiuje krok – etap sekwencji sekwencji. Nie dotyczy Tak
Name Określa nazwę elementu, do którego odwołuje się dany krok. Wartość tego elementu powinna być taka sama jak unikalny identyfikator elementu, np. wartość atrybutu nazwy zasady. Nie dotyczy Tak

Zasady

/sharedflowbundle/policies

Podobnie jak w przypadku serwera proxy interfejsu API, katalog wspólny /policies zawiera plik XML konfiguracji, który zawiera wszystkie zasady, które można dołączyć do przepływu współdzielonego w pakiecie. Zasady współdzielą podzbiór elementów, chociaż jest on powiększany o elementy związane z zasadami. Więcej informacji o konfigurowaniu zasad znajdziesz w temacie dotyczącym wybranych zasad. Możesz też skontaktować się z nimi, korzystając z omówienia zasad.

Zasoby

/sharedflowbundle/resources

Zasoby to skrypty, kod i przekształcenia XSL, które można dołączać do współdzielonych przepływów za pomocą zasad. Są one widoczne w sekcji Skrypty edytora przepływu współdzielonego w interfejsie zarządzania.

Informacje o obsługiwanych typach zasobów znajdziesz w sekcji Pliki zasobów.

Opublikuj pytania na Forum dla programistów Apigee.