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

Xác minh khoá API trong quy trình chia sẻ

Trong ví dụ này, một luồng dùng chung được dùng để thực hiện các tác vụ phổ biến liên quan đến bảo mật. Ở đây, quy trình dùng chung sẽ xác thực khoá API. Proxy API và các luồng dùng chung khác có thể sử dụng chính sách FlowChú thích để thực hiện lệnh gọi đến quy trình dùng chung này.

Định nghĩa về luồng chia sẻ sau đây bao gồm một chính sách Verify-API-Key được thực thi khi luồng được chia sẻ được gọi từ một chính sách FlowChú thích 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 Flowchú thích sau đây (dùng trong một proxy API) sẽ gọi luồng được chia sẻ trước đó để xác minh khoá API. Gói luồng chia sẻ verify-apikey-shared (không hiển thị ở đây) định cấu hình luồng chia sẻ theo cách gói APIProxy định cấu hình 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 tham số vào 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 FlowAnnotation đến một quy trình dùng chung. Ở đây, chính sách FlowAnnotation gọi đến một luồng chung được thiết kế để thực hiện các hàm xử lý chuỗi phổ biến. Luồng chung bao gồm JavaScript liên kết đầu vào, viết thường hoặc cả hai. Chính sách Flowchú thích 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 Flowchú thích String-Handler 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 sử dụng và dữ liệu đầu vào cần sử dụng (ở đây là giá trị cố định kiểu chuỗi, nhưng cũng có thể là biến luồng). Các phần tử Parameter chỉ định tên và giá trị của các biến sẽ 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="operations">concatenate tolowercase</Parameter>
       <Parameter name="outputVariable">string.handler.output</Parameter>
     </Parameters>
     <SharedFlowBundle>StringHandler</SharedFlowBundle>
   </FlowCallout>
   

2. Luồng chia sẻ default sau đây bao gồm chính sách JavaScript SharedStringFunctions. Chính sách này sẽ thực thi khi luồng chia sẻ được gọi từ chính sách Flowchú thích.

   <?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, SharedStringFunctions.js, 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ừ phần tử Parameter của chính sách FlowAnnotation.

   // 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. Hoạt động thực thi sẽ chuyển ngược lại từ chính sách JavaScript, đến luồng được chia sẻ, sau đó đến chính sách FlowAnnotation trong proxy API ban đầu.

Cú pháp

Bạn có thể sử dụng phần tử này với bất kỳ biểu mẫu cú pháp nào sau đây. Lưu ý rằng khi bạn sử dụng 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 FlowChú thích String-Handler này truyền các tham số chỉ định vị trí lưu trữ đầu ra của luồng dùng chung và đầu vào nào sẽ được sử dụng. Các phần tử Parameter chỉ định tên và giá trị của các biến sẽ 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>