Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Alur bersama adalah fungsionalitas yang dapat digunakan kembali yang mirip dengan proxy API. Sebagian besar konten dalam akan tidak asing lagi jika Anda sudah mengenal proxy API.
Jika Anda mempelajari cara membangun 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 yang disertakan dalam paket ini. Lihat Alur bersama. |
Komponen dalam tabel di atas ditentukan oleh file konfigurasi dalam struktur direktori:
File konfigurasi dan struktur direktori paket alur bersama
Bagian ini menjelaskan file konfigurasi dan struktur direktori dari alur bersama paket.
Konfigurasi Dasar
File konfigurasi dasar terletak di direktori utama paket. Namanya adalah nama dari paket tersebut.
/sharedflowbundle/traffic-management-shared.xml
Konfigurasi dasar menentukan konten paket alur bersama, beserta informasi untuk melacak riwayat 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 suatu organisasi. Tujuan
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 dari alur bersama. | T/A | Tidak |
Elemen Konfigurasi Dasar
Nama | Deskripsi | Default | Wajib? |
---|---|---|---|
SharedFlowBundle |
|||
ConfigurationVersion |
Versi skema konfigurasi paket alur bersama yang menjadi tujuan alur bersama ini sesuai. Satu-satunya nilai yang didukung saat ini adalah mainVersion 4 dan minorVersion 0. Ini setelan ini dapat digunakan di masa mendatang untuk memungkinkan evolusi paket alur bersama format font. | 4.0 | Tidak |
CreatedAt dan CreatedBy |
Tanggal/waktu (dalam waktu epoch) saat paket alur bersama dibuat, beserta email pengguna yang membuatnya. | ||
Description |
Deskripsi tekstual dari 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) saat paket alur bersama terakhir diubah, beserta email pengguna yang mengubahnya. | ||
Policies |
Daftar kebijakan dalam direktori /policies dari alur bersama ini. Anda
biasanya hanya akan melihat elemen ini ketika alur bersama dibuat menggunakan Edge
UI manajemen proyek. Ini hanyalah 'manifes' yang dirancang untuk memberikan visibilitas ke
konten dari alur bersama. |
T/A | Tidak |
Resources |
Daftar resource (JavaScript, Python, Java, XSLT) di /resources
dari alur bersama ini. Biasanya Anda hanya akan melihat elemen ini saat alur bersama
dibuat menggunakan UI pengelolaan Edge. Ini hanyalah 'manifes' setelan, yang dirancang untuk
memberikan visibilitas ke dalam konten alur bersama. |
T/A | Tidak |
SharedFlows |
Menentukan alur bersama yang tercakup dalam paket ini.
Perhatikan bahwa saat ini, elemen ini hanya mendukung satu turunan <SharedFlow>. Hanya satu alur bersama dapat ditambahkan ke paket alur bersama. |
T/A | Ya |
Alur bersama
/sharedflowbundle/sharedflows/default.xml
Konfigurasi SharedFlow mendefinisikan urutan di mana elemen alur harus dieksekusi. <SharedFlow> <Step> masing-masing menentukan bagian dari urutan, seperti panggilan ke kebijakan.
Konfigurasi SharedFlow berikut menetapkan tiga kebijakan yang akan dijalankan dalam dari atas ke bawah (dari kiri ke kanan di konsol pengelolaan), dengan pertama-tama kebijakan Penanggulangan lonjakan 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? |
---|---|---|---|
SharedFlow |
|||
name |
Nama alur bersama, yang harus unik dalam suatu organisasi. Tujuan
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 secara eksplisit mengatur nomor revisi, karena Apigee Edge secara otomatis melacak revisi saat ini alur bersama. | T/A | Tidak |
Elemen konfigurasi alur bersama
Nama | Deskripsi | Default | Wajib? |
---|---|---|---|
SharedFlow |
Menentukan urutan kebijakan dalam alur bersama. | T/A | Ya |
Step |
Mendefinisikan langkah -- tahapan dalam urutan alur. | T/A | Ya |
Name |
Menentukan nama item yang dirujuk oleh langkah. Nilai elemen ini harus sama dengan ID unik item, misalnya 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 tersedia untuk dilampirkan ke alur bersama dalam paket.
Kebijakan memiliki satu subkumpulan elemen, meskipun subkumpulan ini ditambahkan dengan elemen yang
spesifik untuk kebijakan tersebut. Untuk mengetahui informasi selengkapnya tentang cara mengonfigurasi kebijakan, lihat topik tentang kebijakan
yang diinginkan. Anda juga dapat menjangkaunya dari Referensi kebijakan
ringkasan.
Resource
/sharedflowbundle/resources
Resource adalah skrip, kode, dan transformasi XSL yang dapat dilampirkan ke alur bersama menggunakan kebijakan. Skrip ini muncul di bagian Skrip pada editor alur bersama di pengelolaan UI.
Lihat File resource untuk mengetahui jenis resource.
Posting pertanyaan ke Forum Developer Apigee.