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

Xác minh khoá API trong quy trình dùng chung

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

Định nghĩa luồng chia sẻ sau đây bao gồm một chính sách Verify-API-Key thực thi khi luồng chia sẻ được gọi từ chính sách FlowAnnotation trong 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 chia sẻ trước đó truy xuất giá trị khoá và xác minh thông tin đó.

<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 FlowAnnotation sau đây (được dùng trong một proxy API) sẽ gọi flow được chia sẻ trước đó đến xác minh khoá API. Gói luồng dùng chung verify-apikey-shared (không xuất hiện tại đâ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 các tham số vào một luồng dùng chung

Ví dụ này minh hoạ cách chuyển thông số từ chính sách FlowAnnotation đến quy trình chung. Ở đây, chính sách FlowAnnotation gọi đến một quy trình chung được thiết kế để thực hiện các hành động phổ biến hàm xử lý chuỗi. Luồng chung bao gồm JavaScript liên kết thông tin đầu vào, chữ thường hay cả hai. Chính sách FlowAnnotation xác định các thông 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 FlowAnnotation String-Handler gọi quy trình chung, truyền các tham số chỉ định biến để lưu trữ đầu ra của luồng được chia sẻ, luồng được chia sẻ nào sẽ sử dụng hoạt động nào và đầu vào nào cần sử dụng (ở đây, giá trị cố định kiểu chuỗi, nhưng cũng có thể là một biến luồng). Phần tử Parameter chỉ định tên và giá trị của biến để tạo thời gian chạy. Luồng chia sẻ 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 một 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 FlowAnnotation.

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

3. Trong quy trình chung, chính sách JavaScript SharedStringFunctions sau đây chỉ định tệp JavaScript SharedStringFunctions.js có mã để 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ừ SharedStringFunctions Chính sách JavaScript. 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. Luồng thực thi quay trở lại từ chính sách JavaScript, tới luồng được chia sẻ, sau đó quay lại 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 một trong các dạng cú pháp sau đây. Xin lưu ý rằng 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ẽ tiêu thụ dữ liệu đó.

<!- 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 chú thích luồng String-Handler này chuyển các thông số chỉ định vị trí để lưu trữ đầu ra của luồng dùng chung và đầu vào nào cần sử dụng. Phần tử Parameter chỉ định tên và giá trị của biến để tạo thời gian chạy. Luồng được chia sẻ có thể truy xuất các biến này để sử dụng trong mã của riêng nó.

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