Zasady dotyczące objaśnień przepływu

Weryfikowanie klucza interfejsu API w przepływie współdzielonym

W tym przykładzie współdzielony przepływ służy do wykonywania typowych zadań związanych z bezpieczeństwem. W tym przypadku przepływ współdzielony sprawdza poprawność klucza interfejsu API. Proxy interfejsu API i inne współdzielone przepływy mogą używać zasady FlowCallout do wywoływania tego współdzielonego przepływu.

Ta definicja współdzielonego przepływu zawiera zasadę Verify-API-Key, która jest wykonywana gdy współdzielony przepływ jest wywoływany przez zasadę FlowCallout w proxy interfejsu API.

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

Zasada VerifyAPIKey w poprzednim współdzielonym przepływie pobiera wartość klucza i weryfikuje ją.

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

Ta zasada FlowCallout, używana w proxy interfejsu API, wywołuje poprzedni przepływ współdzielony, aby zweryfikować klucz interfejsu API. Pakiet przepływu współdzielonego verify-apikey-shared (nie jest tu pokazany) konfiguruje przepływ współdzielony w taki sam sposób, jak pakiet APIProxy konfiguruje proxy.

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

Przekazywanie parametrów do współdzielonego przepływu

Ten przykład pokazuje, jak przekazywać parametry z zasady FlowCallout do współdzielonego przepływu. W tym przypadku zasada FlowCallout wywołuje przepływ współdzielony, który ma wykonywać typowe funkcje obsługi ciągów znaków. Współdzielony przepływ zawiera JavaScript, który łączy dane wejściowe, zamienia je na małe litery lub wykonuje obie te czynności. Zasada FlowCallout definiuje parametry, które określają ciąg wejściowy, wyjściowy i sposób postępowania z danymi wejściowymi.

1. Zasada FlowCallout String-Handler wywołuje współdzielony przepływ, przekazując parametry określające zmienną, w której mają być przechowywane dane wyjściowe współdzielonego przepływu, operację współdzielonego przepływu, która ma być używana, oraz dane wejściowe (w tym przypadku literał ciągu znaków, ale może to być też zmienna przepływu). Elementy Parameter określają nazwy i wartości zmiennych do tworzenia w czasie działania. Współdzielony przepływ może pobierać te zmienne do użycia w swoim kodzie.

   <?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. Ten współdzielony przepływ default zawiera zasadę JavaScript SharedStringFunctions, która jest wykonywana, gdy współdzielony przepływ jest wywoływany przez zasadę FlowCallout.

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

3. W współdzielonym przepływie ta zasada JavaScript SharedStringFunctions określa plik JavaScript SharedStringFunctions.js z kodem do wykonania.

   <?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. Ten JavaScript, SharedStringFunctions.js, jest wykonywany przez SharedStringFunctions zasadę JavaScript. Ten skrypt pobiera wartości z zmiennych utworzonych na podstawie elementów Parameter zasady 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. Wykonanie wraca z zasady JavaScript do współdzielonego przepływu, a następnie do zasady FlowCallout w źródłowym proxy interfejsu API.

Składnia

Możesz użyć tego elementu z dowolną z tych form składni. Pamiętaj, że w przypadku użycia wartości literalnej format określonej wartości będzie zależeć od kodu, który ją wykorzystuje.

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

Przykład

Ta zasada FlowCallout String-Handler przekazuje parametry, które określają, gdzie mają być przechowywane dane wyjściowe przepływu współdzielonego i jakie dane wejściowe mają być używane. Elementy Parameter określają nazwy i wartości zmiennych, które mają być tworzone w czasie działania. Współdzielony przepływ może pobierać te zmienne do użycia w swoim kodzie.

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

Składnia

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