Referensi konfigurasi paket alur bersama

Anda melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

Alur bersama adalah fungsi yang dapat digunakan kembali dan mirip dengan proxy API. Sebagian besar konten referensi ini akan terasa familiar jika Anda sudah memahami proxy API.

Jika Anda mempelajari cara membuat alur bersama, mulailah dengan topik Alur bersama yang dapat digunakan kembali.

Struktur paket alur bersama

Paket alur bersama terdiri dari konfigurasi berikut:

Konfigurasi Dasar Setelan konfigurasi utama. Lihat Konfigurasi Dasar.
Kebijakan File konfigurasi berformat XML yang sesuai dengan skema kebijakan Apigee Edge. Lihat Kebijakan.
Resource Skrip, file JAR, dan file XSLT yang direferensikan oleh kebijakan untuk menjalankan logika kustom. Lihat Resource.
SharedFlows Alur bersama yang disertakan dalam paket ini. Lihat Alur bersama.

Komponen dalam tabel di atas ditentukan oleh file konfigurasi dalam struktur direktori berikut:

File konfigurasi dan struktur direktori paket alur bersama

Bagian ini menjelaskan file konfigurasi dan struktur direktori paket alur bersama.

Konfigurasi Dasar

File konfigurasi dasar terletak di direktori root paket. Namanya adalah nama dari paket.

/sharedflowbundle/traffic-management-shared.xml

Konfigurasi dasar menentukan konten paket alur bersama, beserta informasi untuk melacak histori revisi paket.

<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>

Atribut Konfigurasi Dasar

Nama Deskripsi Default Wajib?
SharedFlowBundle
name Nama paket alur bersama, yang harus unik dalam organisasi. Karakter yang diizinkan untuk digunakan dalam nama dibatasi untuk karakter berikut: A-Za-z0-9_- T/A Ya
revision Nomor revisi konfigurasi paket alur bersama. Anda tidak perlu menetapkan nomor revisi secara eksplisit, karena Apigee Edge secara otomatis melacak revisi alur bersama saat ini. T/A Tidak

Elemen Konfigurasi Dasar

Nama Deskripsi Default Wajib?
SharedFlowBundle
ConfigurationVersion Versi skema konfigurasi paket alur bersama yang sesuai dengan alur bersama ini conforms. Satu-satunya nilai yang didukung saat ini adalah majorVersion 4 dan minorVersion 0. Setelan ini dapat digunakan di masa mendatang untuk memungkinkan evolusi format paket alur bersama. 4.0 Tidak
CreatedAt dan CreatedBy Tanggal/waktu (dalam waktu epoch) saat paket alur bersama dibuat, beserta email pengguna yang membuatnya.
Description Deskripsi tekstual alur bersama. Jika disediakan, deskripsi akan ditampilkan di UI pengelolaan Edge. T/A Tidak
DisplayName Nama yang mudah digunakan dan mungkin berbeda dengan atribut name konfigurasi alur bersama. T/A Tidak
LastModifiedAt dan LastModifiedBy Tanggal/waktu (dalam waktu epoch) saat paket alur bersama terakhir diubah, beserta email pengguna yang mengubahnya.
Policies Daftar kebijakan di direktori /policies alur bersama ini. Anda biasanya hanya akan melihat elemen ini saat alur bersama dibuat menggunakan UI pengelolaan Edge. Setelan ini hanyalah setelan 'manifest', yang dirancang untuk memberikan visibilitas ke dalam konten alur bersama. T/A Tidak
Resources Daftar resource (JavaScript, Python, Java, XSLT) di /resources direktori alur bersama ini. Anda biasanya hanya akan melihat elemen ini saat alur bersama dibuat menggunakan UI pengelolaan Edge. Setelan ini hanyalah setelan 'manifest', yang dirancang untuk memberikan visibilitas ke dalam konten alur bersama. T/A Tidak
SharedFlows Menentukan alur bersama yang terdapat dalam paket ini.

Perhatikan bahwa saat ini, elemen ini hanya mendukung satu turunan <SharedFlow>. Hanya satu alur bersama yang dapat ditambahkan ke paket alur bersama.

T/A Ya

Alur bersama

/sharedflowbundle/sharedflows/default.xml

Konfigurasi SharedFlow menentukan urutan elemen alur yang akan dieksekusi. Setiap elemen turunan <Step> dari elemen <SharedFlow> menentukan bagian dari urutan, seperti panggilan ke kebijakan.

Konfigurasi SharedFlow berikut menentukan tiga kebijakan yang akan dieksekusi dalam urutan atas ke bawah (kiri ke kanan di konsol pengelolaan), dengan kebijakan Spike Arrest terlebih dahulu dan kebijakan Flow Callout terakhir.

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

Atribut konfigurasi alur bersama

Nama Deskripsi Default Wajib?
SharedFlow
name Nama alur bersama, yang harus unik dalam organisasi. Karakter yang diizinkan untuk digunakan dalam nama dibatasi untuk karakter berikut: A-Za-z0-9_- T/A Ya
revision Nomor revisi konfigurasi alur bersama. Anda tidak perlu menetapkan nomor revisi secara eksplisit, karena Apigee Edge secara otomatis melacak revisi alur bersama saat ini. T/A Tidak

Elemen konfigurasi alur bersama

Nama Deskripsi Default Wajib?
SharedFlow Menentukan urutan kebijakan dalam alur bersama. T/A Ya
Step Menentukan langkah -- tahap dalam urutan alur. T/A Ya
Name Menentukan nama item yang direferensikan oleh langkah. Nilai elemen ini harus sama dengan ID unik item, seperti nilai atribut nama kebijakan. T/A Ya

Kebijakan

/sharedflowbundle/policies

Seperti dalam proxy API, dalam paket alur bersama, direktori /policies berisi XML konfigurasi untuk semua kebijakan yang dapat dilampirkan ke alur bersama dalam paket. Kebijakan berbagi subset elemen, meskipun subset ini dilengkapi dengan elemen yang khusus untuk kebijakan. Untuk mengetahui informasi selengkapnya tentang cara mengonfigurasi kebijakan, lihat topik tentang kebijakan yang Anda inginkan. Anda juga dapat mengaksesnya dari Ringkasan referensi kebijakan overview.

Resource

/sharedflowbundle/resources

Resource adalah skrip, kode, dan transformasi XSL yang dapat dilampirkan ke alur bersama menggunakan kebijakan. Resource ini muncul di bagian Skrip editor alur bersama di UI pengelolaan.

Lihat File resource untuk mengetahui jenis resource yang didukung.

Posting pertanyaan ke Forum Developer Apigee.