Anda melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Anda dapat menggabungkan kebijakan dan resource ke dalam alur bersama yang dapat Anda gunakan dari beberapa proxy API, dan bahkan dari alur bersama lainnya. Meskipun seperti proxy, alur bersama tidak memiliki endpoint. Alur bersama hanya dapat digunakan dari proxy API atau alur bersama yang berada di organisasi yang sama dengan alur bersama itu sendiri.
Dengan menangkap fungsi yang berguna di beberapa tempat dalam satu tempat, alur bersama membantu Anda memastikan konsistensi, mempersingkat waktu pengembangan, dan mengelola kode dengan lebih mudah.
Video berikut menunjukkan cara membuat dan melacak alur bersama di UI Edge.
Video 5 menit berikut menunjukkan cara membuat dan melacak alur bersama di UI Edge Klasik (hanya Edge untuk Private Cloud).
Anda dapat memanggil alur bersama menggunakan kebijakan FlowCallout. Selain itu, dengan melampirkan alur bersama ke flow hook, Anda dapat membuat alur bersama dieksekusi sebelum permintaan proxy atau target, atau setelah respons proxy atau target.
Untuk referensi tentang kebijakan FlowCallout, lihat Kebijakan FlowCallout. Untuk mengetahui informasi selengkapnya tentang flow hook, lihat Melampirkan alur bersama menggunakan flow hook.
Misalnya, bayangkan Anda memiliki area fungsi yang digunakan di beberapa tempat atau harus distandardisasi di seluruh API dalam organisasi Anda. Anda dapat memiliki alur bersama untuk setiap kategori, termasuk:
- keamanan, dengan kode otorisasi menggunakan OAuth dan verifikasi kunci API, serta kode perlindungan ancaman.
- logging, untuk membuat pesan error standar.
- mediasi, untuk melakukan transformasi antara format pesan XML dan JSON.
Dalam ilustrasi berikut, dua proxy API memanggil (dengan kebijakan FlowCallout) ke alur bersama untuk mengautentikasi permintaan pengguna yang masuk. AuthSharedFlow telah di-deploy secara terpisah ke organisasi sebelum proxy sehingga tersedia untuk mendukung permintaan dari proxy. Alur bersama dapat dikembangkan dan dikelola oleh tim yang bertanggung jawab atas kebijakan perusahaan yang luas, lalu digunakan dalam proxy oleh tim lini bisnis yang membuat aplikasi yang lebih khusus.

Mengembangkan alur bersama
Saat mengembangkan alur bersama, Anda harus selalu mengujinya dengan panggilan yang dikirim ke proxy API. Dengan kata lain, Anda tidak dapat mengirim permintaan langsung ke alur bersama seperti yang Anda lakukan pada proxy API. Sebagai gantinya, Anda mengirim permintaan ke proxy API yang, pada gilirannya, memanggil alur bersama.
Berikut langkah-langkah tingkat tinggi untuk mengembangkan alur bersama:
- Cari tahu apa yang harus menjadi kumpulan fitur bersama.
Misalnya, Anda mungkin ingin menggabungkan fitur pengelolaan traffic, termasuk menekan traffic lonjakan. Dengan begitu, Anda dapat mengelola konfigurasinya di luar alur kerja orang-orang yang menerapkan logika lini bisnis.
-
Kembangkan alur bersama dengan menerapkan kebijakan dan resource pendukung, seperti yang Anda
lakukan saat mengembangkan proxy API.
Alur bersama adalah urutan langkah bersyarat. Jadi, mengembangkan alur bersama sama seperti mengembangkan proxy API. Anda dapat menyertakan kebijakan dan resource yang mungkin Anda sertakan dalam proxy.
Misalnya, sebagai bagian dari dukungan pengelolaan traffic, Anda dapat menerapkan kebijakan Spike Arrest untuk hanya mengizinkan 30 permintaan per detik, seperti dalam contoh berikut:
<SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest"> <DisplayName>Spike Arrest</DisplayName> <Properties/> <Identifier ref="request.header.some-header-name"/> <MessageWeight ref="request.header.weight"/> <Rate>30ps</Rate> </SpikeArrest>Kemudian, ke alur bersama untuk pengelolaan traffic, Anda dapat melampirkan kebijakan Spike Arrest sebagai langkah. Kebijakan ini akan dijalankan untuk setiap proxy API yang memanggil alur bersama.
<SharedFlow name="default"> <Step> <Name>Spike-Arrest</Name> </Step> </SharedFlow>Untuk mengetahui informasi tentang cara memulai alur bersama di konsol pengelolaan, lihat Membuat alur bersama di UI Edge.
Seperti proxy API, Anda dapat mengimpor file zip yang berisi artefak sumber alur bersama (lihat Mengimpor Proxy API baru untuk mengetahui informasi selengkapnya tentang mengimpor proxy). Berikut ini mengilustrasikan cara mengimpor alur bersama dengan Management API:
curl -X POST -F "file=@/path/to/zip/file.zip" \ 'https://api.enterprise.apigee.com/v1/o/{org_name}/sharedflows?action=import&name=shared-flow-name' \ -u email:password -
Deploy alur bersama ke lingkungan sebelum men-deploy proxy atau alur bersama
yang akan menggunakannya. Anda men-deploy alur bersama dengan cara yang sama seperti men-deploy proxy API. (Untuk mengetahui informasi selengkapnya, lihat Ringkasan deployment.)
Alur bersama harus berada di organisasi yang sama dan di-deploy ke lingkungan yang sama dengan proxy API dan alur bersama lainnya yang menggunakannya. Men-deploy alur bersama sebelum proxy memungkinkan Anda mengatasi dependensi proxy pada alur bersama saat waktu deployment.
Anda dapat men-deploy alur bersama dengan panggilan Management API seperti berikut:
curl -X POST --header "Content-Type: application/octet-stream" \ https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments \ -u email:passwordAnda juga dapat mengganti alur bersama yang saat ini di-deploy tanpa waktu nonaktif. (Hal ini sangat mirip dengan proxy API. Lihat Men-deploy proxy API menggunakan Management API untuk mengetahui informasi selengkapnya). Berikut formulir permintaan menggunakan Management API:
curl -X POST --header "Content-Type:application/x-www-form-urlencoded" \ https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments?"override=true" \ -u email:password -
Kembangkan proxy API yang menggunakan sehingga dapat memanggil alur bersama sebagai bagian dari alurnya sendiri
alur.
Dari proxy API, Anda memanggil alur bersama dengan kebijakan FlowCallout. (Anda juga dapat melampirkan alur bersama ke proxy menggunakan flow hook, seperti yang dijelaskan dalam Melampirkan alur bersama menggunakan flow hook.) Untuk tutorial pengantar tentang cara membuat proxy API, lihat Membangun proxy API pertama Anda.
Untuk menggunakan alur bersama, Anda menambahkan kebijakan FlowCallout ke proxy atau alur bersama yang akan menggunakannya. Seperti kebijakan Panggilan Layanan, yang digunakan untuk memanggil layanan lain, a FlowCallout memanggil alur bersama. Proxy API yang menggunakan harus di-deploy setelah alur bersama dan ke lingkungan yang sama dengan alur bersama. Alur bersama harus ada saat Anda ingin menguji panggilan ke alur bersama menggunakan kebijakan FlowCallout.
Dalam kode berikut, kebijakan FlowCallout memanggil alur bersama yang disebut
traffic-management-shared.<FlowCallout async="false" continueOnError="false" enabled="true" name="Traffic-Management-Flow-Callout"> <DisplayName>Traffic Management FlowCallout</DisplayName> <Properties/> <SharedFlowBundle>traffic-management-shared</SharedFlowBundle> </FlowCallout>Untuk mengetahui informasi selengkapnya, lihat Memanggil alur bersama dari proxy API atau alur bersama
- Deploy proxy API yang menggunakan untuk mulai menggunakan alur bersama. (Untuk mengetahui informasi selengkapnya tentang deployment secara umum, lihat Memahami deployment.)
-
Kembangkan secara berulang dengan melakukan pelacakan, seperti yang Anda lakukan dengan proxy API.
Seperti proxy API, Anda mengembangkan alur bersama dengan memanggil dan melacak secara berulang hingga Anda mendapatkan logika yang Anda inginkan. Dalam hal ini, karena alur bersama tidak berjalan dengan sendirinya, Anda memanggil endpoint proxy dan melacak proxy.
Berikut langkah-langkahnya:
- Pastikan alur bersama dan proxy API yang memanggilnya dengan kebijakan FlowCallout berada di organisasi yang sama dan di-deploy ke lingkungan yang sama.
- Di tab Trace proxy API, mulai lacak proxy API.
- Kirim permintaan ke endpoint proxy di proxy API. Alur dari endpoint harus menyertakan kebijakan FlowCallout yang memanggil alur bersama.
- Di tab Trace, periksa alur dari proxy API ke alur bersama.
Perhatikan bahwa dalam pelacakan, alur bersama direpresentasikan sebagai kumpulan langkah atau kebijakan disertakan dalam kotak abu-abu. Ikon yang mewakili kebijakan FlowCallout mendahului alur bersama. (Untuk mengetahui informasi selengkapnya tentang pelacakan, lihat Menggunakan alat Trace.)

Membuat alur bersama di UI Edge
Saat menggunakan UI Apigee Edge untuk membuat alur bersama, Anda dapat membuatnya dari awal atau dengan mengimpor sumber alur yang ada sebagai file .zip paket alur.
- Akses halaman Alur Bersama, seperti yang dijelaskan di bawah. Di halaman Alur Bersama, Anda dapat melihat daftar alur bersama di organisasi, dan
mengedit atau menghapus alur dalam daftar.
Edge
Untuk mengakses halaman Alur Bersama menggunakan UI Edge:
- Login ke apigee.com/edge.
- Pilih organisasi yang berisi alur bersama Anda. Lihat Beralih antar-organisasi.
Alur bersama akan tersedia untuk proxy API dan alur bersama yang di-deploy ke an lingkungan dari organisasi ini. Alur bersama tidak akan tersedia dari luar organisasi ini.
- Pilih Develop > Shared Flows di panel navigasi kiri.
Edge Klasik (Private Cloud)
Untuk mengakses halaman Alur Bersama menggunakan UI Edge Klasik:
- Login ke
http://ms-ip:9000, dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan. - Pilih organisasi yang berisi alur bersama Anda. Lihat Beralih antar-organisasi.
Alur bersama akan tersedia untuk proxy API dan alur bersama yang di-deploy ke an lingkungan dari organisasi ini. Alur bersama tidak akan tersedia dari luar organisasi ini.
- Pilih APIs > Shared Flows di menu navigasi atas.
- Klik tombol + Shared Flow untuk mulai menambahkan alur bersama baru.
- Di halaman Build a Shared Flow, pilih cara Anda ingin membuat alur baru:
- Buat alur baru dari awal. Anda akan dapat mengonfigurasi kebijakan dan resource sebagai
langkah-langkah dalam alur.
- Pilih Empty Shared Flow.
- Masukkan nilai nama. Nama ini akan digunakan oleh proxy API dan alur bersama lainnya untuk mereferensikan alur bersama ini. Nama tersebut harus deskriptif bagi developer yang menggunakan alur.
- Masukkan deskripsi untuk memberikan informasi selengkapnya tentang fungsi alur.
- Klik Next.
- Secara opsional, pilih lingkungan tempat Anda ingin men-deploy alur baru.
Misalnya, jika Anda akan menguji alur bersama dari proxy API yang di-deploy ke lingkungan pengujian, deploy alur bersama ke test.
-
Klik Build and Deploy agar alur bersama baru dibuat dan di-deploy ke lingkungan yang Anda pilih. Jika Anda tidak memilih lingkungan, alur bersama akan dibuat, tetapi tidak di-deploy.
- Buat alur bersama dari sumber yang ada dengan mengupload paket alur.
- Pilih Shared Flow Bundle untuk menentukan file .zip yang berisi artefak
yang Anda inginkan dalam alur baru.
Paket alur bersama berisi artefak sumber alur bersama. Misalnya, jika Anda mendownload alur bersama dari UI Edge, Anda akan memiliki file .zip dengan paket alur.
- Klik Next.
- Klik Choose File untuk menelusuri file .zip yang berisi sumber alur bersama yang ingin Anda impor.
- Di kotak Shared Flow Name, masukkan nama untuk alur yang diimpor. Nama ini akan digunakan oleh proxy API dan alur bersama lainnya untuk mereferensikan alur bersama ini. Nama tersebut harus deskriptif bagi developer yang menggunakan alur.
- Klik Next.
- Klik Build untuk membuat alur baru dari sumber yang Anda impor.
- Pilih Shared Flow Bundle untuk menentukan file .zip yang berisi artefak
yang Anda inginkan dalam alur baru.
- Buat alur baru dari awal. Anda akan dapat mengonfigurasi kebijakan dan resource sebagai
langkah-langkah dalam alur.
Memanggil alur bersama dari proxy API atau alur bersama
Anda dapat memanggil alur bersama dari proxy atau dari alur bersama lain menggunakan kebijakan FlowCallout.
- Di UI Edge, temukan proxy atau alur bersama yang ingin Anda gunakan untuk memanggil alur bersama lain.
- Di Navigator, di samping Policies, klik tombol +.
- Dalam daftar kebijakan, di bagian Extension, klik FlowCallout.
- Masukkan nama tampilan dan nama (ID unik), lalu pilih alur bersama yang akan dipanggil oleh kebijakan ini.
- Klik Add.
- Tambahkan kebijakan FlowCallout baru ke proxy tempat Anda ingin melakukan panggilan.