JavaScript 政策

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

結果

這項政策可讓你新增自訂 JavaScript 程式碼，在 API 環境內執行 以及 Proxy 流程在自訂 JavaScript 程式碼中，您可以使用 Apigee Edge JavaScript 物件模型。您可以使用物件模型 變數。個人中心 也可以使用物件模型提供的基本加密編譯函式。

關於

JavaScript 政策有許多用途，舉例來說，您可以取得 執行自訂邏輯並執行錯誤處理、從要求或要求中擷取資料 以及動態編輯後端目標網址等等。這項政策可讓你 實作其他標準 Edge 政策未涵蓋的自訂行為。事實上，您 也能使用 JavaScript 政策來達到其他政策實作的許多相同行為。 例如 AssignMessage 和 ExtractVariable

一個不建議 JavaScript 政策的用途是記錄一種用途。訊息記錄政策有許多 更適合記錄第三方記錄平台，例如 Splunk、Sumo 和 Loggly，以及 只要在 PostClientFlow 中執行 Message Logging 政策，即可改善 API Proxy 效能。 ，在回應傳回用戶端後執行。

JavaScript 政策可讓您指定要執行的 JavaScript 來源檔案，或是 您可以直接使用 <Source>，直接在政策設定中加入 JavaScript 程式碼 元素。 無論選擇哪一種方式，JavaScript 程式碼都會在執行附加政策的步驟時執行。 對於來源檔案選項，原始碼一律會儲存在 Proxy 組合中的標準位置：apiproxy/resources/jsc。您還能 將原始碼儲存在環境或機構層級的資源檔案中。適用對象 操作說明，請參閱「資源檔案」一節。你可以 也能透過 Apigee UI Proxy 編輯器上傳 JavaScript。

JavaScript 來源檔案一律必須具有 .js 副檔名。

請參閱支援的軟體和支援的版本 瞭解系統目前支援的 JavaScript 版本。

影片

請觀看短片，瞭解如何使用 JavaScript 建立自訂政策擴充功能 政策。

範例

curl -i -H 'Content-Type: application/x-www-form-urlencoded' -X POST -d 'user=Will' http://myorg-test.apigee.net/js-example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="target-rewrite">
    <DisplayName>target-rewrite</DisplayName>
    <Properties/>
    <ResourceURL>jsc://js-example.js</ResourceURL>
</Javascript>

元素參照

元素參考資料將說明 JavaScript 政策的元素和屬性。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Javascript async="false" 
        continueOnError="false" enabled="true" timeLimit="200" 
        name="JavaScript-1">
    <DisplayName>JavaScript 1</DisplayName>
    <Properties>
        <Property name="propName">propertyValue</Property>
    </Properties>
    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>
    <IncludeURL>jsc://a-javascript-library-file</IncludeURL>
    <ResourceURL>jsc://my-javascript-source-file</ResourceURL>
    <Source>insert_js_code_here</Source>

</Javascript>

<Javascript>屬性

<Javascript name="Javascript-1" enabled="true" continueOnError="false" async="false" timeLimit="200">

以下是這項政策專用屬性。

下表說明所有政策父項元素的共同屬性：

<DisplayName>元素

除 name 屬性外，一併使用 管理 UI Proxy 編輯器，使用不同的自然語言名稱。

<DisplayName>Policy Display Name</DisplayName>

<IncludeURL>元素

指定要載入做為主要 JavaScript 檔案的依附元件的 JavaScript 程式庫檔案 透過 <ResourceURL> 或 <Source> 元素指定。系統會在 政策中列出的順序。您的程式碼可以使用各種物件、方法和 JavaScript 物件模型的屬性。

加入多個含有額外項目的 JavaScript 依附元件資源 <IncludeURL> 元素。

<IncludeURL>jsc://my-javascript-dependency.js</IncludeURL>

範例

請參閱「範例」一節中的基本範例。

<Property>元素

指定您可以在執行階段從 JavaScript 程式碼存取的屬性。

<Properties>
    <Property name="propName">propertyValue</Property>
</Properties>

屬性

範例

請參閱「範例」一節中的範例。

<ResourceURL>元素

指定要在 API 流程中執行的主要 JavaScript 檔案。您可以儲存這個檔案 在 API Proxy 範圍 (在 API Proxy 套件中的 /apiproxy/resources/jsc 下，或 API Proxy 編輯器「Navigator」窗格的「Scripts」部分，或在機構層級 環境範圍，以便在多個 API Proxy 中重複使用，如「資源檔案」所述。程式碼可以使用物件 JavaScript 物件模型的方法以及屬性。

<ResourceURL>jsc://my-javascript.js</ResourceURL>

範例

請參閱「範例」一節中的基本範例。

<Source>元素

允許您將 JavaScript 直接插入政策的 XML 設定中。插入 在 API 流程中執行政策時，系統會執行 JavaScript 程式碼。

範例

<Javascript name='JS-ParseJsonHeaderFullString' timeLimit='200' >
  <Properties>
    <Property name='inboundHeaderName'>specialheader</Property>
    <Property name='outboundVariableName'>json_stringified</Property>
  </Properties>
  <Source>
var varname = 'request.header.' + properties.inboundHeaderName + '.values.string';
var h = context.getVariable(varname);
if (h) {
  h = JSON.parse(h);
  h.augmented = (new Date()).valueOf();
  var v = JSON.stringify(h, null, 2) + '\n';
  // further indent
  var r = new RegExp('^(\S*)','mg');
  v= v.replace(r,'    $1');
  context.setVariable(properties.outboundVariableName, v);
}
  </Source>
</Javascript>

<SSLInfo>元素

為由 Proxy 建立的所有 HTTP 用戶端執行個體，指定用於設定 TLS 的屬性 JavaScript 政策。

    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>

為 HTTP 用戶端設定 TLS 的程序與設定 TLS 的程序相同 TargetEndpoint/TargetServer 的 TLS。 請參閱設定從 Edge 到後端的 TLS。 瞭解詳情

使用須知

JavaScript 政策不含任何實際程式碼。相反地，JavaScript 政策會參照 JavaScript 的「資源」，並且定義執行 JavaScript 的 API 流程步驟。你可以 透過管理使用者介面 Proxy 編輯器上傳指令碼，也可以將指令碼加入 /resources/jsc 目錄 (位於本機開發的 API Proxy 中)。

對 JavaScript 政策程式碼進行偵錯

使用 print() 函式將偵錯資訊輸出至交易 輸出面板如需詳細資訊和範例，請參閱「使用 JavaScript 偵錯」 print() 陳述式。

如要在 Trace 中查看列印陳述式，請按照下列步驟操作：

1. 開啟追蹤工具，然後為含有 JavaScript 的 Proxy 啟動追蹤工作階段 政策。
2. 呼叫 Proxy。
3. 在追蹤記錄工具中，按一下「Output from all Transactions」(所有交易的輸出) 以開啟輸出內容。 面板。

   

4. 你的輸出對帳單會顯示在這個面板中。

您可以使用 print() 函式將偵錯資訊輸出至「追蹤工具」。這個函式可直接使用 讀取及傳遞資訊詳情請參閱「使用 print() 對 JavaScript 進行偵錯 Statement。

流程變數

在預設情況下，這項政策不會填入任何變數。不過，您可以設定 只要在結構定義物件上呼叫方法，即可在 JavaScript 程式碼中測試變數。典型模式 如下所示：

context.setVariable("response.header.X-Apigee-Target", context.getVariable("target.name"))

結構定義物件是 Apigee Edge JavaScript 物件模型的一部分。

錯誤參考資料

本節說明系統傳回的錯誤代碼和錯誤訊息，以及錯誤變數。 這項政策觸發錯誤時，由 Edge 設定的。請務必瞭解 您必須制定錯誤規則 處理錯誤詳情請參閱這篇文章 瞭解政策錯誤和處理方式 發生錯誤

執行階段錯誤

執行政策時，可能會發生這些錯誤。

部署錯誤

當您部署含有這項政策的 Proxy 時，可能會發生這些錯誤。

錯誤變數

當這項政策在執行階段觸發錯誤時，即可設定這些變數。如需更多資訊 見你什麼 需要瞭解政策錯誤

錯誤回應範例

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Javascript runtime error: "ReferenceError: "status" is not defined. (setresponse.js:6)\"",
    "detail": {
      "errorcode": "steps.javascript.ScriptExecutionFailed"
    }
  }
}

錯誤規則範例

<FaultRule name="JavaScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(javascript.JavaScript-1.failed = true) </Condition>
</FaultRule>

結構定義

每種政策類型都是由 XML 架構 (.xsd) 定義。供參考政策結構定義 GitHub 提供許多資源。

相關主題

• JavaScript 物件模型
• 如需操作說明、政策範例和 JavaScript 範例，請參閱程式設計 API 使用 JavaScript 的 Proxy。

Apigee 社群文章

您可以前往 Apigee 參閱這些相關文章 社群：

• 如何在 JavaScript 中處理多值標頭？