Dokumentacja konfiguracji przepływu współdzielonego

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Współdzielony przepływ to funkcja wielokrotnego użytku podobna do serwera proxy interfejsu API. Większość treści będą już znane, jeśli znasz już serwery proxy interfejsu API.

Jeśli dopiero uczysz się tworzyć przepływy wspólne, zacznij od przeczytania artykułu Udostępnione przepływy wielokrotnego użytku.

Struktura pakietów przepływu współdzielonego

Pakiet współdzielonych przepływów składa się z tej konfiguracji:

Konfiguracja podstawowa Główne 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 AutoML, do których odwołują się zasady, aby wykonywać niestandardową logikę. Zobacz Materiały.
SharedFlows Przepływy współdzielone zawarte w tym pakiecie. Zobacz Udostępnione przepływy.

Komponenty w tabeli powyżej są zdefiniowane przez pliki konfiguracji w tych plikach struktura katalogów:

Pliki konfiguracji i struktura katalogów udostępnionego pakietu przepływów

W tej sekcji omawiamy pliki konfiguracji i strukturę katalogów dla współdzielonego przepływu w pakiecie.

Konfiguracja podstawowa

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

/sharedflowbundle/traffic-management-shared.xml

Konfiguracja podstawowa definiuje zawartość udostępnianego pakietu przepływów wraz z informacjami służy 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 Wymagana?
SharedFlowBundle
name Nazwa udostępnionego pakietu przepływu, która musi być niepowtarzalna w obrębie organizacji. dozwolone w nazwie są ograniczone do: A-Za-z0-9_- Nie dotyczy Tak
revision Numer wersji konfiguracji udostępnionego pakietu przepływów. Nie musisz tego robić bezpośrednio ustawisz numer wersji, ponieważ Apigee Edge automatycznie śledzi bieżącą wersji udostępnianego procesu. Nie dotyczy Nie

Podstawowe elementy konfiguracji

Nazwa Opis Domyślny Wymagana?
SharedFlowBundle
ConfigurationVersion Wersja schematu konfiguracji udostępnionego pakietu przepływu, do którego został użyty ten wspólny przepływ się zgadza. Obecnie jedyną obsługiwaną wartością jest wersja mainVersion 4 i podrzędnaVersion 0. Ten może zostać użyte w przyszłości, aby umożliwić ewolucję wspólnego pakietu przepływu . 4.0 Nie
CreatedAt i CreatedBy Data i godzina (w czasie epoki) utworzenia udostępnianego pakietu przepływu, wraz z parametrem adres e-mail użytkownika, który go utworzył.
Description Tekstowy opis udostępnianego procesu. Jeśli zostanie podany, opis będzie wyświetlany w w interfejsie zarządzania krawędziami. Nie dotyczy Nie
DisplayName Przyjazna dla użytkownika nazwa, która może się różnić od atrybutu name atrybutu konfiguracji przepływu współdzielonego. Nie dotyczy Nie
LastModifiedAt i LastModifiedBy Data i godzina (w czasie epoki) ostatniej modyfikacji udostępnianego pakietu przepływu, wraz z informacjami adres e-mail użytkownika, który go zmodyfikował.
Policies Lista zasad w katalogu /policies tego współdzielonego przepływu. Ty zwykle widzi ten element tylko wtedy, gdy udostępniany przepływ został utworzony za pomocą Edge za pomocą prostego interfejsu zarządzania. To po prostu „manifest” ma umożliwiać wgląd w zawartości udostępnianego przepływu. Nie dotyczy Nie
Resources Lista zasobów (JavaScript, Python, Java, GPT) w interfejsie /resources katalogu tego współdzielonego procesu. Zazwyczaj będziesz widzieć ten element tylko podczas wspólnej procedury zostało utworzone za pomocą interfejsu zarządzania brzegiem. To po prostu „manifest” które ma na celu i zapewniają wgląd w zawartość udostępnianego przepływu. Nie dotyczy Nie
SharedFlows Określa wspólny przepływ zawarty w tym pakiecie.

Pamiętaj, że obecnie ten element obsługuje tylko jeden element podrzędny <SharedFlow>. Tylko jedna wspólne przepływy mogą być dodawane do udostępnionego pakietu przepływu.

 Nie dotyczy Tak

Przepływy współdzielone

/sharedflowbundle/sharedflows/default.xml

Konfiguracja SharedFlow określa kolejność, w jakiej mają być wykonywane elementy przepływu. <SharedFlow> <Step> elementu każdy z nich określa część sekwencji, na przykład wezwanie do zasad.

W poniższej konfiguracji SharedFlow określono 3 zasady do wykonania sekwencja od góry do dołu (od lewej do prawej w konsoli zarządzania) z zasadą aresztowania spirytusa i widokiem Zasady dotyczące wywołań procesu 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ślny Wymagana?
SharedFlow
name Nazwa udostępnionego przepływu, która musi być niepowtarzalna w obrębie organizacji. dozwolone w nazwie są ograniczone do: A-Za-z0-9_- Nie dotyczy Tak
revision Numer wersji współdzielonej konfiguracji przepływu. Nie musisz specjalnie ustawiać numer wersji, ponieważ Apigee Edge automatycznie śledzi bieżącą wersję wspólne przepływy pracy. Nie dotyczy Nie

Elementy konfiguracji przepływu wspólnego

Nazwa Opis Domyślny Wymagana?
SharedFlow Definiuje 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ć taki sam jak unikalny identyfikator produktu, np. wartość atrybutu nazwa zasady. Nie dotyczy Tak

Zasady

/sharedflowbundle/policies

Podobnie jak w przypadku serwera proxy interfejsu API, w udostępnionym pakiecie przepływów katalog /policies zawiera XML konfiguracji dla wszystkich zasad, które można dołączyć do udostępnianego przepływu w pakiecie. Zasady współużytkują podzbiór elementów, ale ten podzbiór jest poszerzany o elementy, które są: i zasad. Więcej informacji o konfigurowaniu zasad znajdziesz w temacie dotyczącym tych zasad w dowolnym momencie. Możesz je również znaleźć w Informacjach o zasadach .

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. Pojawią się one w sekcji Skrypty w edytorze przepływu współdzielonego na stronie zarządzania Interfejs.

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

Zadaj pytania na forum dla programistów Apigee.