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

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

Bu örnekte, paylaşılan bir akış güvenlikle ilgili yaygın görevleri gerçekleştirmek için kullanılmıştı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 FlowCall politikasını kullanabilir.

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

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

Önceki paylaşılan akıştaki 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>

API proxy'sinde kullanılan aşağıdaki FlowCall 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 paketinin proxy yapılandırdığı ş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 bir akışa parametre iletme

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

1. String-Handler FlowHeader politikası, paylaşılan akışı çağırarak paylaşılan akışın çıkışını depolayacak değişkeni, hangi paylaşılan akış işleminin kullanılacağını ve hangi girdinin kullanılacağını belirten parametreleri iletir (burada sabit bir dize ancak akış değişkeni de olabilir). Parameter öğeleri, çalışma zamanı oluşturulacak 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ışı, bir FlowCall politikasından paylaşılan akış ç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ı, yürütülecek 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 olan SharedStringFunctions.js, SharedStringFunctions JavaScript politikasından yürütülür. Bu komut dosyası, FlowAçıklama politikası Parameter öğelerinden oluşturulan değişkenlerden değer 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 işlemi JavaScript politikasından paylaşılan akışa, ardından kaynak API proxy'sindeki FlowCall politikasına geri döner.

Söz dizimi

Bu öğeyi aşağıdaki söz dizimi biçimlerinin herhangi biriyle kullanabilirsiniz. Değişmez değer kullandığınız durumlarda, 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

Paylaşılan akışın çıkışının nerede depolanacağını ve hangi girişin kullanılacağını belirten bu String-Handler FlowHeader politikası iletme parametreleri. Parameter öğeleri, çalışma zamanı oluşturulacak 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="outputVariable">string.handler.output</Parameter>
  </Parameters>
  <SharedFlowBundle>StringHandler</SharedFlowBundle>
</FlowCallout>

Söz dizimi

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