Anda sedang 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. Fungsi ini 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 di 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 berdurasi 5 menit berikut menunjukkan cara membuat dan melacak alur bersama di UI Klasik Edge (khusus 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 proxy atau permintaan target, atau setelah proxy atau respons target.
Untuk referensi tentang kebijakan FlowCallout, lihat kebijakan FlowCallout. Untuk mengetahui informasi selengkapnya tentang flow hook, lihat Melampirkan flow bersama menggunakan flow hook.
Misalnya, bayangkan Anda memiliki area fungsi yang digunakan di beberapa tempat atau harus distandarisasi di seluruh API di organisasi Anda. Anda dapat memiliki alur bersama untuk setiap kategori, termasuk:
- security, dengan kode otorisasi yang menggunakan verifikasi kunci OAuth dan API, serta kode perlindungan terhadap ancaman.
- logging, untuk membuat pesan error standar.
- mediasi, untuk 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 organisasi dapat mendukung permintaan dari proxy. Alur bersama dapat dikembangkan dan dikelola oleh tim yang bertanggung jawab atas kebijakan perusahaan yang luas, lalu digunakan di 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 kemudian memanggil alur bersama.
Berikut adalah langkah-langkah tingkat tinggi untuk mengembangkan alur bersama:
- Cari tahu kumpulan fitur bersama yang seharusnya.
Misalnya, Anda mungkin ingin menggabungkan fitur pengelolaan traffic, termasuk menekan lonjakan traffic. Dengan demikian, Anda dapat mengelola konfigurasinya di luar alur kerja 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, mengembangkannya seperti mengembangkan proxy API. Anda dapat menyertakan kebijakan dan resource yang mungkin disertakan 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 akan dijalankan untuk setiap proxy API yang memanggil alur bersama.
<SharedFlow name="default"> <Step> <Name>Spike-Arrest</Name> </Step> </SharedFlow>
Untuk 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 adalah cara mengimpor alur bersama dengan API pengelolaan:
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 memakainya. 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 resolusi dependensi proxy pada alur bersama pada 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:password
Anda juga dapat mengganti alur bersama yang saat ini di-deploy tanpa periode nonaktif. (Ini sangat mirip dengan proxy API. Lihat Men-deploy proxy API menggunakan Management API untuk mengetahui informasi selengkapnya). Berikut adalah 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 agar dapat memanggil alur bersama sebagai bagian dari alurnya
sendiri.
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 Mem-build proxy API pertama Anda.
Untuk menggunakan alur bersama, Anda menambahkan kebijakan FlowCallout ke proxy atau alur bersama yang akan menggunakannya. Seperti kebijakan Info Layanan, yang digunakan untuk memanggil layanan lain, 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 tersebut menggunakan kebijakan FlowCallout.
Dalam kode berikut, kebijakan Flow callout 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 iteratif dengan pelacakan, seperti yang Anda lakukan dengan proxy API.
Seperti proxy API, Anda mengembangkan alur bersama dengan memanggil dan melacak secara iteratif hingga Anda memiliki logika seperti yang Anda inginkan. Dalam hal ini, karena flow bersama tidak berjalan secara mandiri, 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 serangkaian langkah atau kebijakan yang diapit 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 ini. 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 antarorganisasi.
Alur bersama akan tersedia untuk semua proxy API dan alur bersama yang di-deploy ke suatu lingkungan dari organisasi ini. Aplikasi tidak akan tersedia dari luar organisasi ini.
- Pilih Develop > Shared Flows di menu navigasi sebelah 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 semua proxy API dan alur bersama yang di-deploy ke lingkungan dari organisasi ini. Aplikasi tidak akan tersedia dari luar organisasi ini.
- Pilih API > Alur Bersama di menu navigasi atas.
- Klik tombol + Alur Bersama untuk mulai menambahkan alur bersama baru.
- Di halaman Membuat Alur Bersama, pilih cara Anda ingin membuat alur baru:
- Buat alur baru dari awal. Anda dapat mengonfigurasi kebijakan dan resource sebagai langkah dalam alur.
- Pilih Kosong Alur Bersama.
- Masukkan nilai nama. Ini akan menjadi nama yang digunakan proxy API dan alur bersama lainnya untuk mereferensikan alur bersama ini. Nama harus deskriptif bagi developer yang menggunakan alur.
- Masukkan deskripsi untuk memberikan informasi selengkapnya tentang fungsi alur.
- Klik Berikutnya.
- 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 pengujian.
-
Klik Build and Deploy untuk membuat dan men-deploy alur bersama baru 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 bersama paket alur.
- Klik Berikutnya.
- Klik Pilih File untuk mencari file .zip yang berisi sumber alur bersama yang ingin Anda impor.
- Di kotak Nama Alur Bersama, masukkan nama untuk alur yang diimpor. Nama ini akan menjadi nama yang digunakan oleh proxy API dan alur bersama lainnya untuk mereferensikan alur bersama ini. Nama harus deskriptif bagi developer yang menggunakan alur.
- Klik Berikutnya.
- Klik Build untuk membangun 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 dapat mengonfigurasi kebijakan dan resource sebagai langkah dalam alur.
Memanggil alur bersama dari proxy API atau alur bersama
Anda dapat memanggil alur bersama dari proxy atau dari alur bersama lainnya menggunakan kebijakan Flowcallout.
- Di UI Edge, temukan proxy atau alur bersama tempat Anda ingin memanggil alur bersama lainnya.
- Di Navigator, di samping Kebijakan, klik tombol +.
- Dalam daftar kebijakan, klik FlowCallout di bagian Ekstensi.
- Masukkan nama tampilan dan nama (ID unik), lalu pilih alur bersama yang akan dipanggil oleh kebijakan ini.
- Klik Tambahkan.
- Tambahkan kebijakan FlowCallout baru ke proxy tempat Anda ingin panggilan dilakukan.