Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Alur bersama adalah fungsi yang dapat digunakan kembali yang mirip dengan proxy API. Sebagian besar referensi ini akan familier jika Anda sudah mengenal 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. |
Referensi | Skrip, file JAR, dan file XSLT yang dirujuk oleh kebijakan untuk menjalankan logika kustom. Lihat Resource. |
SharedFlows | Alur bersama 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 dari paket alur bersama.
Konfigurasi Dasar
File konfigurasi dasar terletak di direktori utama paket. Nama paket merupakan 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 diisi? |
---|---|---|---|
SharedFlowBundle |
|||
name |
Nama paket alur bersama, yang harus unik dalam organisasi. Karakter yang boleh Anda gunakan dalam nama dibatasi untuk hal 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 otomatis melacak revisi saat ini dari alur bersama. | T/A | Tidak |
Elemen Konfigurasi Dasar
Nama | Deskripsi | Default | Wajib diisi? |
---|---|---|---|
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 mengaktifkan 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 tentang alur bersama. Jika disediakan, deskripsi akan ditampilkan di UI pengelolaan Edge. | T/A | Tidak |
DisplayName |
Nama yang mudah digunakan yang mungkin berbeda dari atribut name konfigurasi alur bersama. |
T/A | Tidak |
LastModifiedAt dan LastModifiedBy |
Tanggal/waktu (dalam waktu epoch) paket alur bersama terakhir diubah, beserta email pengguna yang mengubahnya. | ||
Policies |
Daftar kebijakan dalam direktori /policies dari alur bersama ini. Biasanya, Anda
hanya akan melihat elemen ini ketika alur bersama dibuat menggunakan UI
pengelolaan Edge. Ini hanyalah setelan 'manifes', yang dirancang untuk memberikan visibilitas ke dalam
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 ketika alur bersama dibuat menggunakan UI pengelolaan Edge. Ini hanyalah setelan 'manifes', yang dirancang untuk
memberikan visibilitas ke dalam konten alur bersama. |
T/A | Tidak |
SharedFlows |
Menentukan alur bersama yang terdapat dalam paket ini.
Perlu diketahui 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 mendefinisikan urutan eksekusi elemen alur. Elemen turunan <Step> dari elemen <SharedFlow> masing-masing menentukan bagian dari 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 Penahanan Lonjakan terlebih dahulu dan kebijakan Pemanggilan Alur 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 diisi? |
---|---|---|---|
SharedFlow |
|||
name |
Nama alur bersama, yang harus unik dalam organisasi. Karakter yang boleh Anda gunakan dalam nama dibatasi untuk hal 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 otomatis melacak revisi saat ini dari alur bersama. | T/A | Tidak |
Elemen konfigurasi alur bersama
Nama | Deskripsi | Default | Wajib diisi? |
---|---|---|---|
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 dirujuk oleh langkah. Nilai elemen ini harus sama dengan ID unik item, seperti nilai atribut nama kebijakan. | 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 berbagi subkumpulan elemen, meskipun subkumpulan ini ditambah dengan elemen yang
khusus untuk kebijakan. Untuk informasi selengkapnya tentang cara mengonfigurasi kebijakan, lihat topik tentang kebijakan yang
Anda inginkan. Anda juga dapat membukanya dari Ringkasan referensi
kebijakan.
Referensi
/sharedflowbundle/resources
Resource adalah skrip, kode, dan transformasi XSL yang dapat dilampirkan ke alur bersama menggunakan kebijakan. Keduanya muncul di bagian Skrip pada editor alur bersama di UI pengelolaan.
Lihat File resource untuk jenis resource yang didukung.
Posting pertanyaan ke Forum Developer Apigee.