Kebijakan FlowCallout

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

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 diterapkan sebagai kebijakan, seperti dalam proxy API. Kebijakan FlowCallout memberi Anda cara untuk memanggil alur bersama dari proxy API dan alur bersama lainnya. Cara kerjanya sama 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 mewakili konvensi Anda untuk 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 bersama lainnya dengan menerapkan kebijakan FlowCallout dari dalam alur bersama.

Kebijakan ini adalah Kebijakan yang dapat diperluas dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau penggunaan, bergantung pada lisensi Apigee Anda. Untuk informasi tentang jenis kebijakan dan implikasi penggunaan, lihat Jenis kebijakan.

Catatan: Untuk mengetahui informasi selengkapnya tentang alur bersama, lihat Alur bersama yang dapat digunakan kembali. Anda juga dapat memanggil alur bersama dari luar kode proxy API untuk menerapkan prapemrosesan permintaan atau pascapemrosesan respons untuk semua Proxy API yang di-deploy di lingkungan. Untuk mengetahui informasi selengkapnya, lihat Melampirkan alur bersama menggunakan hook alur.

Sampel

Memverifikasi kunci API dalam alur bersama

Dalam contoh ini, alur bersama digunakan untuk melakukan tugas umum terkait keamanan. Di sini, flow 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 dieksekusi 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 di proxy API, memanggil alur bersama 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 alur bersama

Contoh ini mengilustrasikan cara meneruskan parameter dari kebijakan FlowCallout ke alur bersama. Di sini, kebijakan FlowCallout memanggil alur bersama yang dirancang untuk menjalankan fungsi penanganan string umum. Alur bersama mencakup JavaScript yang menyambungkan inputnya, mengubah inputnya menjadi huruf kecil, atau keduanya. Kebijakan FlowCallout menentukan parameter yang menentukan input string, output, dan tindakan yang akan dilakukan dengan input.

1. Kebijakan String-Handler FlowCallout memanggil alur bersama, meneruskan parameter yang menentukan variabel untuk menyimpan output alur bersama, operasi alur bersama yang akan digunakan, dan input yang akan digunakan (di sini, literal string, tetapi juga dapat berupa variabel alur). 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="operations">concatenate tolowercase</Parameter>
       <Parameter name="outputVariable">string.handler.output</Parameter>
     </Parameters>
     <SharedFlowBundle>StringHandler</SharedFlowBundle>
   </FlowCallout>

2. Alur bersama default berikut menyertakan kebijakan JavaScript SharedStringFunctions 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>

3. Dalam alur bersama, kebijakan JavaScript SharedStringFunctions berikut menentukan file JavaScript SharedStringFunctions.js dengan kode yang akan dieksekusi.

   <?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>

4. JavaScript berikut, SharedStringFunctions.js, dijalankan dari kebijakan JavaScript SharedStringFunctions. Skrip ini mengambil nilai dari variabel yang dibuat dari elemen Parameter 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);

5. 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 pada 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 umum untuk semua elemen induk kebijakan:

Atribut	Deskripsi	Default	Kehadiran
name	Nama internal kebijakan. Nilai atribut name dapat berisi huruf, angka, spasi, tanda hubung, garis bawah, dan titik. Nilai ini tidak boleh melebihi 255 karakter. Secara opsional, gunakan elemen <DisplayName> untuk memberi label pada kebijakan di editor proxy UI pengelolaan dengan nama bahasa alami yang berbeda.	T/A	Wajib
continueOnError	Tetapkan ke false untuk menampilkan error saat kebijakan gagal. Perilaku ini wajar terjadi untuk sebagian besar kebijakan. Tetapkan ke true agar eksekusi alur berlanjut meskipun setelah kebijakan gagal. Lihat juga: Aturan error HANYA dipicu dalam status error (tentang continueOnError) Menangani error dalam alur saat ini	false	Opsional
enabled	Tetapkan ke true untuk menerapkan kebijakan. Tetapkan ke false untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap terlampir ke alur.	benar	Opsional
async	Atribut ini tidak digunakan lagi.	false	Tidak digunakan lagi

Elemen <DisplayName>

Gunakan selain atribut name untuk melabeli kebijakan di editor proxy UI pengelolaan dengan nama bahasa alami yang berbeda.

<DisplayName>Policy Display Name</DisplayName>

Default	T/A Jika Anda menghapus elemen ini, nilai atribut name kebijakan akan digunakan.
Kehadiran	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 flow 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) yang akan diteruskan sebagai variabel ke 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 konseptual, hal ini 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.

Sintaks

Anda dapat menggunakan elemen ini dengan salah satu bentuk sintaksis berikut. Perhatikan bahwa saat Anda menggunakan nilai literal, format nilai yang Anda tentukan akan bergantung pada kode yang menggunakannya.

<!- 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 String-Handler FlowCallout ini meneruskan parameter yang menentukan tempat menyimpan 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	Kehadiran	Jenis
name	Nama variabel runtime yang akan dibuat dengan parameter ini.	Tidak ada	Wajib	String
ref	Variabel yang berisi nilai yang akan digunakan 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 harus menjadi sumber nilai.	Tidak ada	Opsional	String

Elemen <Parameters>

Menentukan kumpulan elemen <Parameter> yang akan diteruskan sebagai variabel ke dalam alur bersama yang dipanggil oleh kebijakan ini.

Sintaks

<Parameters>
  <Parameter name="parameter-name" value='parameter-value' />
</Parameters>

Default	T/A
Kehadiran	Opsional
Jenis	T/A

Atribut

Tidak ada.

Skema

Contoh: Lihat contoh repositori GitHub kami untuk mengetahui skema terbaru.

Variabel alur

Variabel alur memungkinkan perilaku dinamis kebijakan dan alur saat runtime, berdasarkan header HTTP, konten pesan, atau konteks alur. Untuk mengetahui informasi selengkapnya tentang variabel Flow, lihat Referensi variabel.

Variabel	Deskripsi
apigee.edge.sharedflow.name	Cakupan: Selama eksekusi alur bersama Jenis: String Izin: Baca Nilai atribut nama alur bersama.
apigee.edge.flowhook.name	Cakupan: Selama eksekusi alur bersama yang dilampirkan ke hook alur. Jenis: String Izin: Baca Nama hook alur.

Referensi error

Bagian ini menjelaskan kode error dan pesan error yang ditampilkan serta variabel error yang ditetapkan oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan error untuk menangani error. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani error.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Tips: Perlu bantuan untuk mengatasi error? Klik di kolom Perbaiki untuk mendapatkan informasi pemecahan masalah mendetail.

Gunakan Pemantauan API untuk menyelidiki kode error dan mendiagnosis masalah dengan lebih cepat.

Kode kerusakan	Status HTTP	Penyebab	Perbaiki
flow.SharedFlowNotFound	500	Alur bersama tidak ada, atau alur bersama ada tetapi tidak di-deploy.

Error saat deployment

T/A

Topik terkait

• Membuat alur bersama: Alur bersama yang dapat digunakan kembali
• Menjalankan alur bersama di beberapa proxy: Melampirkan alur bersama menggunakan hook alur