Referensi konfigurasi paket alur bersama

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Alur bersama adalah fungsi yang dapat digunakan kembali, mirip dengan proxy API. Untuk informasi selengkapnya, lihat Membuat alur bersama yang dapat digunakan kembali.

Struktur direktori paket alur bersama

Struktur direktori paket alur bersama, yang ditampilkan di bawah, mirip dengan struktur direktori konfigurasi proxy API.

Struktur direktori paket alur bersama

Konfigurasi paket alur bersama terdiri dari konten berikut:

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

Konfigurasi dasar

File konfigurasi dasar terletak di direktori root paket. Namanya adalah nama 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 valid mencakup: A-Za-z0-9_- T/A Ya
revision Nomor revisi konfigurasi paket alur bersama. Anda tidak perlu menetapkan nomor revisi secara eksplisit karena Apigee 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. 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 flow bersama. 4.0 Tidak
CreatedAt dan CreatedBy Tanggal/waktu (dalam waktu epoch) saat paket alur bersama dibuat, dan email pengguna yang membuatnya.
Description Deskripsi tekstual alur bersama. Jika disediakan, deskripsi akan ditampilkan di UI Apigee. T/A Tidak
DisplayName Nama yang mudah digunakan yang mungkin berbeda dari atribut name dari 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. Ini hanyalah setelan 'manifes', yang dirancang untuk memberikan visibilitas ke konten alur bersama. T/A Tidak
Resources Daftar resource (JavaScript, Python, Java, XSLT) di direktori /resources dari alur bersama ini. Biasanya, Anda hanya akan melihat elemen ini saat alur bersama dibuat menggunakan UI Apigee. Ini hanyalah setelan manifes, yang dirancang untuk memberikan visibilitas ke konten alur bersama. T/A Tidak
SharedFlows Alur bersama yang terdapat dalam paket ini. T/A Ya

Kebijakan

/sharedflowbundle/policies

Seperti pada proxy API, dalam paket alur bersama, direktori /policies berisi XML konfigurasi untuk semua kebijakan yang tersedia untuk dilampirkan ke alur bersama dalam paket. Kebijakan memiliki subset elemen yang sama, meskipun subset ini dilengkapi dengan elemen yang khusus untuk kebijakan. Untuk mengetahui informasi selengkapnya tentang cara mengonfigurasi kebijakan, lihat Ringkasan referensi kebijakan.

Resource

/sharedflowbundle/resources

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

Lihat Mengelola resource untuk jenis resource yang didukung.

Alur bersama

/sharedflowbundle/sharedflows/default.xml

Konfigurasi SharedFlow menentukan urutan elemen alur yang harus dijalankan. Setiap elemen turunan <Step> elemen <SharedFlow> menentukan bagian urutan, seperti panggilan ke kebijakan.

Konfigurasi SharedFlow berikut menentukan tiga kebijakan yang akan dijalankan dalam urutan dari atas ke bawah (kiri ke kanan di konsol pengelolaan), dengan kebijakan SpikeArrest terlebih dahulu dan kebijakan FlowCallout 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 valid mencakup: A-Za-z0-9_- T/A Ya
revision Nomor revisi konfigurasi alur bersama. Anda tidak perlu menetapkan nomor revisi secara eksplisit karena Apigee secara otomatis melacak revisi saat ini dari alur bersama. T/A Tidak

Elemen konfigurasi alur bersama

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