Chính sách về chú thích

Xác minh khoá API trong luồng dùng chung

Trong ví dụ này, một luồng dùng chung được dùng để thực hiện các tác vụ thường gặp liên quan đến bảo mật. Ở đây, luồng dùng chung sẽ xác thực khoá API. Các proxy API và những luồng dùng chung khác có thể sử dụng chính sách FlowCallout để thực hiện các lệnh gọi vào luồng dùng chung này.

Định nghĩa về luồng dùng chung sau đây bao gồm một chính sách Verify-API-Key thực thi khi luồng dùng chung được gọi từ một chính sách FlowCallout trong một proxy API.

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

Chính sách VerifyAPIKey trong luồng dùng chung trước đó sẽ truy xuất giá trị khoá và xác minh giá trị đó.

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

Chính sách FlowCallout sau đây, được dùng trong một proxy API, sẽ gọi quy trình dùng chung trước đó để xác minh khoá API. Gói luồng dùng chung verify-apikey-shared (không xuất hiện ở đây) sẽ định cấu hình luồng dùng chung theo cách mà gói APIProxy định cấu hình một proxy.

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

Truyền các tham số đến một luồng dùng chung

Ví dụ này minh hoạ cách truyền các tham số từ chính sách FlowCallout đến một luồng dùng chung. Ở đây, chính sách FlowCallout gọi đến một luồng dùng chung được thiết kế để thực hiện các hàm xử lý chuỗi phổ biến. Luồng chia sẻ bao gồm JavaScript nối đầu vào, chuyển đổi đầu vào thành chữ thường hoặc cả hai. Chính sách FlowCallout xác định các tham số chỉ định đầu vào, đầu ra của chuỗi và việc cần làm với đầu vào.

1. Chính sách String-Handler FlowCallout gọi luồng dùng chung, truyền các tham số chỉ định biến để lưu trữ đầu ra của luồng dùng chung, thao tác luồng dùng chung cần dùng và đầu vào cần dùng (ở đây là một chuỗi ký tự, nhưng cũng có thể là một biến luồng). Các phần tử Parameter chỉ định tên và giá trị của các biến để tạo thời gian chạy. Luồng dùng chung có thể truy xuất các biến này để sử dụng trong mã của riêng mình.

   <?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. Luồng default dùng chung sau đây bao gồm một chính sách SharedStringFunctions JavaScript sẽ thực thi khi luồng dùng chung được gọi từ chính sách FlowCallout.

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

3. Trong luồng dùng chung, chính sách JavaScript SharedStringFunctions sau đây chỉ định tệp JavaScript SharedStringFunctions.js có mã cần thực thi.

   <?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 sau đây (SharedStringFunctions.js) sẽ thực thi từ chính sách JavaScript SharedStringFunctions. Tập lệnh này truy xuất các giá trị từ các biến được tạo từ các phần tử chính sách 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. Quá trình thực thi quay lại từ chính sách JavaScript, đến luồng dùng chung, sau đó đến chính sách FlowCallout trong proxy API ban đầu.

Cú pháp

Bạn có thể sử dụng phần tử này với một trong các dạng cú pháp sau. Xin lưu ý rằng khi bạn sử dụng một giá trị cố định, định dạng của giá trị mà bạn chỉ định sẽ phụ thuộc vào mã sử dụng giá trị đó.

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

Ví dụ

Chính sách String-Handler FlowCallout này truyền các tham số chỉ định nơi lưu trữ đầu ra của luồng dùng chung và đầu vào cần sử dụng. Các phần tử Parameter chỉ định tên và giá trị của các biến để tạo thời gian chạy. Luồng dùng chung có thể truy xuất các biến này để sử dụng trong mã riêng.

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

Cú pháp

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