Zasady dotyczące objaśnień przepływu

Zweryfikuj klucz interfejsu API w udostępnionym przepływie

W tym przykładzie wspólny przepływ jest używany do wykonywania typowych zadań związanych z bezpieczeństwem. Tutaj Wspólny przepływ weryfikuje klucz interfejsu API. Serwery proxy interfejsu API i inne współdzielone przepływy mogą używać rozszerzenia FlowCallout zgodnie z zasadami dotyczącymi korzystania ze wspólnego procesu.

Poniższa definicja przepływu współdzielonego zawiera zasadę Verify-API-Key, która jest wykonywana gdy udostępniany przepływ jest wywoływany z zasady FlowCallout na serwerze proxy API.

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

Zasada VerifyAPIKey w ramach poprzedniego udostępnionego przepływu pobiera wartość klucza i zostanie potwierdzona.

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

Poniższa zasada FlowCallout, używana na serwerze proxy interfejsu API, wywołuje poprzedni udostępniony przepływ do zweryfikować klucz interfejsu API. Pakiet przepływu współdzielonego (verify-apikey-shared) (niewidoczny tutaj) konfiguruje udostępniony przepływ tak, jak pakiet APIProxy konfiguruje serwer 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 udostępnianego przepływu

Ten przykład pokazuje, jak przekazywać parametry z zasady FlowCallout do wspólne przepływy pracy. Tutaj zasada Flowobjaśnienia wywołuje wspólny proces mający na celu wykonanie wspólnych funkcje obsługi ciągów znaków. Wspólny przepływ obejmuje kod JavaScript, który łączy dane wejściowe, będzie zapisywać dane wejściowe małymi literami lub w obu tych miejscach. Zasada FlowCallout definiuje parametry określające dane wejściowe i wyjściowe oraz co z nimi zrobić.

1. Zasada Flowobjaśnienia String-Handler wywołuje wspólny proces, przekazywanie parametrów określających zmienną do przechowywania danych wyjściowych wspólnego przepływu, a także oraz jakich danych wejściowych użyć (w tym przypadku może to być literał łańcuchowy, zmienną przepływu). Elementy Parameter określają nazwy i wartości zmiennych aby utworzyć środowisko wykonawcze. Wspólny przepływ może pobierać te zmienne do własnego kodu.

   <?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. Poniższy udostępniony przepływ default zawiera zasadę JavaScript SharedStringFunctions, która jest wykonywana, gdy wspólny przepływ jest wywoływany z zasady FlowCallout.

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

3. W ramach procesu współdzielonego następujące zasady JavaScriptu: 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. Poniższy kod JavaScript (SharedStringFunctions.js) jest wykonywany z SharedStringFunctions zasada JavaScript. Ten skrypt pobiera wartości z zmienne utworzone na podstawie elementów zasady FlowCallout Parameter.

   // 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 następuje z poziomu zasady JavaScriptu do wspólnego przepływu, a następnie do Zasada FlowCallout w źródłowym serwerze proxy interfejsu API.

Składnia

Tego elementu możesz używać w dowolnej z podanych niżej form składni. Pamiętaj, że użyj wartości literału, format podanej wartości będzie zależny od kodu pochłaniają tę wartość.

<!- 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 Flowobjaśnienia (String-Handler) przekazuje parametry, które określają, gdzie do przechowywania danych wyjściowych wspólnego przepływu i danych wejściowych, które mają być używane. Elementy Parameter określać nazwy i wartości zmiennych służące do utworzenia środowiska wykonawczego. Wspólny proces umożliwia pobieranie do użycia w osobnym 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>