Akış Çağrısı politikası

Paylaşılan akışta API anahtarını doğrulama

Bu örnekte, yaygın güvenlik görevlerini gerçekleştirmek için paylaşılan bir akış kullanılmaktadır. Burada, paylaşılan akış bir API anahtarını doğrular. API proxy'leri ve diğer paylaşılan akışlar, bu paylaşılan akışa çağrı yapmak için FlowCallout politikasını kullanabilir.

Aşağıdaki paylaşılan akış tanımı, paylaşılan akış bir API proxy'sindeki FlowCallout politikasından çağrıldığında yürütülen bir Verify-API-Key politikası içerir.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SharedFlow name="default">
    <Step>
        <Name>Verify-API-Key</Name>
    </Step>
</SharedFlow>

Önceki paylaşılan akış içindeki VerifyAPIKey politikası, anahtar değerini alır ve doğrular.

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key">
    <DisplayName>Verify API Key</DisplayName>
    <APIKey ref="request.queryparam.apikey"/>
</VerifyAPIKey>

Bir API proxy'sinde kullanılan aşağıdaki FlowCallout politikası, API anahtarını doğrulamak için önceki paylaşılan akışı çağırır. verify-apikey-shared paylaşılan akış paketi (burada gösterilmemiştir), paylaşılan akışı bir APIProxy paketi proxy'yi yapılandıracak şekilde yapılandırır.

<FlowCallout async="false" continueOnError="false" enabled="true" name="Auth-Flow-Callout">
    <DisplayName>Auth Flow Callout</DisplayName>
    <SharedFlowBundle>verify-apikey-shared</SharedFlowBundle>
</FlowCallout>

Paylaşılan akışa parametre iletme

Bu örnekte, FlowCallout politikasından paylaşılan bir akışa parametrelerin nasıl geçirileceği gösterilmektedir. Burada, FlowCallout politikası, yaygın dize işleme işlevlerini gerçekleştirmek için tasarlanmış bir paylaşılan akışı çağırır. Paylaşılan akış, girişini birleştiren, girişinin küçük harfli olmasını sağlayan veya her ikisini de yapan JavaScript'i içeriyor. FlowCallout politikası, dize girişini, çıkışını ve girişle ne yapılacağını belirten parametreleri tanımlar.

1. String-Handler FlowCallout politikası, paylaşılan akışı çağırır. Bu sırada, paylaşılan akışın çıkışını depolayacak değişkeni, hangi paylaşılan akış işleminin ve hangi girişin kullanılacağını belirten parametreler iletilir (burada dize değişmez değeri kullanılır ancak akış değişkeni de kullanılabilir). Parameter öğeleri, çalışma zamanı oluşturmak için değişkenlerin adlarını ve değerlerini belirtir. Paylaşılan akış, bu değişkenleri kendi kodunda kullanmak üzere alabilir.

   <?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. Aşağıdaki default paylaşılan akış, FlowCallout politikası tarafından çağrıldığında yürütülen bir SharedStringFunctions JavaScript politikası içerir.

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <SharedFlow name="default">
     <Step>
       <Name>SharedStringFunctions</Name>
     </Step>
   </SharedFlow>

3. Paylaşılan akışta aşağıdaki SharedStringFunctions JavaScript politikası çalıştırılacak kodu içeren SharedStringFunctions.js JavaScript dosyasını belirtir.

   <?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. Aşağıdaki JavaScript, SharedStringFunctions.js, SharedStringFunctions JavaScript politikasından yürütülür. Bu komut dosyası, FlowCallout politikası Parameter öğelerinden oluşturulan değişkenlerden değerleri alır.

   // 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. Yürütme, JavaScript politikasından paylaşılan akışa, ardından da kaynak API proxy'sindeki FlowCallout politikasına geri döner.

Söz dizimi

Bu öğeyi aşağıdaki söz dizimi biçimlerinden herhangi biriyle kullanabilirsiniz. Sabit değer kullandığınızda, belirttiğiniz değerin biçiminin, değeri kullanan koda bağlı olacağını unutmayın.

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

Örnek

Bu String-Handler FlowCallout politikası, paylaşılan akışın çıktısının nerede depolanacağını ve hangi girişin kullanılacağını belirten parametreleri iletir. Parameter öğeleri çalışma zamanı oluşturmak için değişkenlerin adlarını ve değerlerini belirtir. Paylaşılan akış, kendi kodunda kullanılmak üzere bu değişkenleri alabilir.

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

Söz dizimi

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