Kebijakan FlowInfo

Memverifikasi kunci API di alur bersama

Dalam contoh ini, alur bersama digunakan untuk melakukan tugas terkait keamanan umum. Di sini, alur bersama memvalidasi kunci API. Proxy API dan alur bersama lainnya dapat menggunakan kebijakan FlowInfo untuk melakukan panggilan ke alur yang dibagikan ini.

Definisi flow bersama berikut menyertakan kebijakan Verify-API-Key yang dijalankan saat alur bersama dipanggil dari kebijakan FlowInfo 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 akan 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 FlowInfo 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 yang dibagikan 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 menggambarkan cara meneruskan parameter dari kebijakan FlowInfo ke alur bersama. Di sini, kebijakan FlowInfo memanggil flow bersama yang dirancang untuk menjalankan fungsi penanganan string umum. Alur bersama menyertakan JavaScript yang menggabungkan inputnya, menggunakan huruf kecil untuk inputnya, atau keduanya. Kebijakan FlowInfo menentukan parameter yang menentukan input string, output, dan tindakan yang harus dilakukan terhadap input tersebut.

1. Kebijakan FlowInfo String-Handler memanggil flow bersama, meneruskan parameter yang menentukan variabel untuk menyimpan output alur bersama, operasi flow bersama yang akan digunakan, dan input yang akan digunakan (di sini, literal string, tetapi juga dapat berupa variabel flow). Elemen Parameter menentukan nama dan nilai variabel untuk membuat runtime. Alur bersama dapat mengambil variabel tersebut 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 FlowInfo.

   <?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, dieksekusi dari kebijakan JavaScript SharedStringFunctions. Skrip ini mengambil nilai dari variabel yang dibuat dari elemen Parameter kebijakan FlowInfo.

   // 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 FlowInfo di proxy API asal.

Sintaksis

Anda dapat menggunakan elemen ini dengan salah satu formulir sintaksis berikut. Perhatikan bahwa di mana 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 FlowInfo kebijakan String-Handler yang meneruskan parameter yang menentukan tempat untuk menyimpan output flow bersama dan input apa 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>

Sintaksis

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