Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Gunakan kebijakan FlowCallout untuk memanggil alur bersama dari proxy API atau alur bersama lainnya.
Dalam alur bersama, Anda membuat urutan langkah yang dapat digunakan kembali pada waktu proses dari beberapa tempat. Langkah-langkah ini diimplementasikan sebagai kebijakan, seperti dalam proxy API. Kebijakan FlowCallout memberi Anda cara untuk memanggil alur bersama dari proxy API dan alur bersama lainnya. Fungsinya seperti panggilan fungsi dalam bahasa pemrograman tradisional.
- Misalnya, bayangkan Anda telah membuat alur bersama dengan fitur keamanan seperti verifikasi kunci API, validasi token OAuth, dan perlindungan ekspresi reguler. Alur bersama ini merepresentasikan konvensi Anda tentang cara memeriksa permintaan masuk. Dengan menggunakan kebijakan FlowCallout, Anda dapat memanggil alur bersama tersebut dari beberapa proxy API.
- Anda dapat memanggil satu alur bersama dari alur lainnya dengan menerapkan kebijakan FlowCallout dari dalam alur bersama.
Contoh
Memverifikasi kunci API di alur bersama
Dalam contoh ini, alur bersama digunakan untuk melakukan tugas umum terkait keamanan. Di sini, alur bersama memvalidasi kunci API. Proxy API dan alur bersama lainnya dapat menggunakan kebijakan FlowCallout untuk melakukan panggilan ke alur bersama ini.
Definisi alur bersama berikut menyertakan kebijakan Verify-API-Key
yang dijalankan saat alur bersama dipanggil dari kebijakan FlowCallout di proxy API.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SharedFlow name="default"> <Step> <Name>Verify-API-Key</Name> </Step> </SharedFlow>
Kebijakan VerifyAPIKey
dalam alur bersama sebelumnya mengambil nilai kunci dan memverifikasinya.
<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key"> <DisplayName>Verify API Key</DisplayName> <APIKey ref="request.queryparam.apikey"/> </VerifyAPIKey>
Kebijakan FlowCallout berikut, yang digunakan dalam proxy API, memanggil alur yang dibagikan sebelumnya untuk
memverifikasi kunci API. Paket alur bersama verify-apikey-shared
(tidak ditampilkan di sini) mengonfigurasi alur bersama dengan cara paket APIProxy mengonfigurasi proxy.
<FlowCallout async="false" continueOnError="false" enabled="true" name="Auth-Flow-Callout"> <DisplayName>Auth Flow Callout</DisplayName> <SharedFlowBundle>verify-apikey-shared</SharedFlowBundle> </FlowCallout>
Meneruskan parameter ke flow bersama
Contoh ini menggambarkan cara meneruskan parameter dari kebijakan FlowCallout ke alur bersama. Di sini, kebijakan FlowCallout memanggil alur bersama yang dirancang untuk menjalankan fungsi penanganan string yang umum. Alur bersama menyertakan JavaScript yang menyambungkan inputnya, menggunakan huruf kecil pada inputnya, atau keduanya. Kebijakan FlowCallout menentukan parameter yang menentukan input, output string, dan fungsi input tersebut.
Kebijakan FlowCallout
String-Handler
memanggil alur bersama, yang meneruskan parameter yang menentukan variabel untuk menyimpan output alur bersama, operasi alur bersama yang akan digunakan, dan input apa yang akan digunakan (di sini, literal string, tetapi juga bisa berupa variabel alur). ElemenParameter
menentukan nama dan nilai variabel untuk membuat runtime. Alur bersama dapat mengambil variabel ini untuk digunakan dalam kodenya sendiri.<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FlowCallout async="false" continueOnError="false" enabled="true" name="String-Handler"> <DisplayName>String Handler</DisplayName> <Parameters> <Parameter name="input">Gladys Kravitz</Parameter> <Parameter name="operations">concatenate tolowercase</Parameter> <Parameter name="outputVariable">string.handler.output</Parameter> </Parameters> <SharedFlowBundle>StringHandler</SharedFlowBundle> </FlowCallout>
Alur bersama
default
berikut menyertakan kebijakan JavaScriptSharedStringFunctions
yang dijalankan saat alur bersama dipanggil dari kebijakan FlowCallout.<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SharedFlow name="default"> <Step> <Name>SharedStringFunctions</Name> </Step> </SharedFlow>
Dalam alur bersama, kebijakan JavaScript
SharedStringFunctions
berikut menentukan file JavaScript SharedStringFunctions.js dengan kode yang akan dijalankan.<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="SharedStringFunctions"> <DisplayName>SharedStringFunctions</DisplayName> <Properties/> <ResourceURL>jsc://SharedStringFunctions.js</ResourceURL> </Javascript>
JavaScript berikut, SharedStringFunctions.js, dijalankan dari kebijakan JavaScript
SharedStringFunctions
. Skrip ini mengambil nilai dari variabel yang dibuat dari elemenParameter
kebijakan FlowCallout.// Input value from the calling API proxy. var handledString = context.getVariable("input"); // Variable to use for output from this script. var outputVariable = context.getVariable("outputVariable"); // A space-separated list of things to do to the input string. // Convert to lower case to handle unintentional capitals in configuration. var operation = context.getVariable("operations").toLowerCase(); // If "lowercase" was given as an operation, convert the input to lowercase. if (operation.includes("tolowercase")) { handledString = handledString.toLowerCase(); } // If "concatenate" was given as an operation, concatenate the input. if (operation.includes("concatenate")) { handledString = handledString.replace(/\s+/g, ''); } // Assign the resulting string to the output variable specified by // the calling API proxy. context.setVariable(outputVariable, handledString);
- Eksekusi mengalir kembali dari kebijakan JavaScript, ke alur bersama, lalu ke kebijakan FlowCallout di proxy API asal.
Referensi elemen
Berikut adalah elemen dan atribut yang dapat Anda konfigurasi di kebijakan ini:
<FlowCallout async="false" continueOnError="false" enabled="true" name="Flow-Callout-1"> <DisplayName>Custom label used in UI</DisplayName> <SharedFlowBundle>thereferencedsharedflowbundle</SharedFlowBundle> </FlowCallout>
Atribut <FlowCallout>
<FlowCallout async="false" continueOnError="false" enabled="true" name="Flow-Callout-1">
Tabel berikut menjelaskan atribut yang sama untuk semua elemen induk kebijakan:
Atribut | Deskripsi | Default | Ketersediaan |
---|---|---|---|
name |
Nama internal kebijakan. Nilai atribut Atau, gunakan elemen |
T/A | Wajib |
continueOnError |
Setel ke Setel ke |
false | Opsional |
enabled |
Setel ke Setel ke |
true | Opsional |
async |
Atribut ini sudah tidak digunakan lagi. |
false | Tidak digunakan lagi |
Elemen <DisplayName>
Gunakan selain atribut name
untuk memberi label kebijakan di
editor proxy UI pengelolaan dengan nama natural-language yang berbeda.
<DisplayName>Policy Display Name</DisplayName>
Default |
T/A Jika Anda menghapus elemen ini, nilai atribut |
---|---|
Ketersediaan | Opsional |
Jenis | String |
Elemen <SharedFlowBundle>
Menentukan nama alur bersama yang akan dipanggil. Nilai elemen ini harus sama dengan nilai atribut nama elemen SharedFlowBundle target.
<SharedFlowBundle/>
Dalam contoh paling sederhana, Anda memberikan nama flow bersama yang dipanggil sebagai nilai untuk elemen ini. Artinya, nilai elemen ini harus sama dengan nilai atribut name
alur bersama.
<SharedFlowBundle>Shared-Flow-Name</SharedFlowBundle>
Default | T/A |
Kehadiran |
Wajib. |
Jenis | T/A |
Atribut
Tidak ada.
Elemen <Parameter>
Menentukan parameter dan nilai (atau sumber nilai) untuk diteruskan sebagai variabel ke dalam alur bersama yang dipanggil oleh kebijakan ini.
Dengan menggunakan parameter, Anda dapat menentukan nilai (atau variabel yang berisi nilai) yang harus diteruskan ke alur bersama yang dipanggil oleh kebijakan. Secara konsep mirip dengan menentukan parameter dalam panggilan fungsi. Seperti parameter fungsi, nilai parameter FlowCallout dapat bervariasi berdasarkan konteks panggilan alur bersama.
Parameter FlowCallout hanya terlihat selama eksekusi alur bersama.
Sintaksis
Anda dapat menggunakan elemen ini dengan salah satu formulir sintaksis berikut. Perhatikan bahwa jika Anda menggunakan nilai literal, format nilai yang Anda tentukan akan bergantung pada kode yang memakainya.
<!- A literal value in an attribute. --/> <Parameter name="parameter-name" value='parameter-value' /> <!- A reference to a variable in an attribute. --/> <Parameter name="parameter-name" ref='source-variable-name' /> <!- A literal value in the element content. --/> <Parameter name="parameter-name">parameter-value</Parameter> <!- An reference to an attribute in the element content. --/> <Parameter name="parameter-name">{source-variable-name}</Parameter>
Contoh
Kebijakan FlowCallout String-Handler
ini meneruskan parameter yang menentukan tempat
penyimpanan output alur bersama dan input yang akan digunakan. Elemen Parameter
menentukan nama dan nilai variabel untuk membuat runtime. Alur bersama dapat mengambil variabel ini untuk digunakan dalam kodenya sendiri.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <FlowCallout async="false" continueOnError="false" enabled="true" name="String-Handler"> <DisplayName>String Handler</DisplayName> <Parameters> <Parameter name="input">Gladys Kravitz</Parameter> <Parameter name="outputVariable">string.handler.output</Parameter> </Parameters> <SharedFlowBundle>StringHandler</SharedFlowBundle> </FlowCallout>
Default | T/A |
Kehadiran |
Wajib. |
Jenis | T/A |
Atribut
Atribut | Deskripsi | Default | Ketersediaan | Jenis |
---|---|---|---|---|
name | Nama variabel runtime yang akan dibuat dengan parameter ini. | Tidak ada. | Wajib. | String |
referensi |
Variabel yang berisi nilai untuk digunakan pada saat runtime. Hapus atribut ini jika Anda menentukan nilai literal yang akan digunakan. |
Tidak ada. | Opsional. | String |
value | Nilai yang akan digunakan dalam variabel runtime yang dibuat dengan parameter ini. Hapus atribut ini jika Anda menentukan nama variabel yang seharusnya menjadi sumber nilai. | Tidak ada. | Opsional. | String |
Elemen <Parameters>
Menentukan kumpulan elemen <Parameter> untuk diteruskan sebagai variabel ke dalam alur bersama yang dipanggil oleh kebijakan ini.
Sintaksis
<Parameters> <Parameter name="parameter-name" value='parameter-value' /> </Parameters>
Default | T/A |
Kehadiran |
Opsional. |
Jenis | T/A |
Atribut
Tidak ada.
Skema
Variabel alur
Variabel alur memungkinkan perilaku dinamis kebijakan dan alur pada runtime, berdasarkan header HTTP, konten pesan, atau konteks alur. Untuk informasi selengkapnya tentang variabel Alur, lihat Referensi variabel.
Variabel | Deskripsi |
---|---|
|
Cakupan: Selama eksekusi flow bersama Nilai atribut nama alur bersama. |
|
Cakupan: Selama eksekusi flow bersama yang terpasang ke hook
alur. Nama flow hook. |
Referensi error
Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan serta variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan fault untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.
Error runtime
Error ini dapat terjadi saat kebijakan dieksekusi.
Kode kesalahan | Status HTTP | Penyebab | Perbaiki |
---|---|---|---|
flow.SharedFlowNotFound |
500 | Alur bersama tidak ada, atau alur bersama ada tetapi tidak di-deploy. | build |
Error saat deployment
T/A
Topik terkait
- Membuat alur bersama: Alur bersama yang dapat digunakan kembali
- Mengeksekusi alur bersama di beberapa proxy: Melampirkan alur bersama menggunakan flow hook