反模式：從 API Proxy 叫用 Apigee API 呼叫

您目前查看的是 Apigee 和 Apigee Hybrid 說明文件。
查看 Apigee Edge 說明文件。

Apigee 提供強大的公用程式，稱為 Apigee API，可提供下列服務：

  • 部署或取消部署 API Proxy
  • 設定虛擬主機、金鑰儲存區和信任儲存區等
  • 建立、刪除及更新實體，例如鍵/值對應 (KVM)、API 產品、開發人員應用程式、開發人員、消費者金鑰等
  • 擷取這些實體的相關資訊

這些服務可透過 Apigee 平台中稱為「管理伺服器」的元件存取。只要透過簡單的 API 呼叫，即可輕鬆叫用這些服務。

有時我們可能需要在執行階段使用 API Proxy 中的一或多項服務。這是因為 KVM、OAuth 存取權杖、API 產品、開發人員應用程式、開發人員、消費者金鑰等實體，都以鍵/值組合、自訂屬性或設定檔的形式，包含實用資訊。

舉例來說，您可以在 KVM 中儲存下列資訊，確保資訊安全無虞，並在執行階段存取：

  • 後端目標網址
  • 環境屬性
  • 後端或第三方系統的安全憑證

同樣地，您可能想在執行階段取得 API 產品清單或開發人員的電子郵件地址。 這項資訊會顯示在開發人員應用程式設定檔中。

您可以在執行階段有效運用所有這些資訊，在 Apigee 的政策或自訂程式碼中啟用動態行為。

反模式

建議使用 Apigee API 執行管理工作，不應在 API Proxy 流程中執行任何執行階段邏輯。可能的原因如下：

  • 使用 Apigee API 從 API Proxy 存取實體 (例如 KVM、OAuth 存取權杖) 的相關資訊，或用於任何其他用途，都會導致依附於管理伺服器。
  • 管理伺服器不屬於 Apigee 執行階段元件，因此可能不具備高可用性。
  • 管理伺服器也可能無法在相同網路或資料中心內佈建，因此可能會在執行階段造成網路延遲。
  • 管理伺服器中的項目會快取較長的時間，因此如果您在短時間內執行寫入和讀取作業，可能無法立即在 API Proxy 中看到最新資料。
  • 增加執行階段的網路躍點。

在下方的程式碼範例中，Apigee API 呼叫是透過自訂 JavaScript 程式碼進行，可從 KVM 擷取資訊：

var response = httpClient.send('https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/keyvaluemaps')

如果管理伺服器無法使用，則叫用 Apigee API 呼叫的 JavaScript 程式碼會失敗。這會導致 API 要求失敗。

影響

  • 在執行階段導入管理伺服器的額外依附元件。管理伺服器發生任何故障，都會影響 API 呼叫。
  • Apigee API 的使用者憑證必須儲存在本機或加密 KVM 等安全儲存空間。
  • 透過網路叫用管理服務時，效能會受到影響。
  • 由於管理伺服器中的快取到期時間較長，您可能不會立即看到更新的值。

最佳做法

在執行階段，從實體 (例如 KVM、API 產品、開發人員應用程式、開發人員、消費者金鑰等) 擷取資訊時，有更有效率的方法。以下是一些例子：

  • 使用 KeyValueMapOperations 政策存取 KVM 中的資訊。以下是範例程式碼，說明如何從 KVM 擷取資訊：
    <!-- /antipatterns/examples/2-6.xml -->
<KeyValueMapOperations mapIdentifier="urlMap" async="false"
    continueOnError="false" enabled="true" name="GetURLKVM">
  <DisplayName>GetURLKVM</DisplayName>
  <ExpiryTimeInSecs>86400</ExpiryTimeInSecs>
  <Scope>environment</Scope>
  <Get assignTo="urlHosti" index="2">
    <Key>
      <Parameter>urlHost_1</Parameter>
    </Key>
  </Get>
</KeyValueMapOperations>
  • 如要在 API Proxy 中存取 API 產品、開發人員應用程式、開發人員、消費者金鑰等相關資訊，請執行下列任一操作：
    • 如果 API Proxy 流程有 VerifyAPIKey 政策，您可以使用此政策填入的流程變數存取資訊。以下是範例程式碼，說明如何使用 JavaScript 擷取開發人員應用程式的名稱和 created_by 資訊：
      <!-- /antipatterns/examples/2-7.xml -->
print("Application Name ", context.getVariable(""verifyapikey. VerifyAPIKey.app.name"));
print("Created by:", context.getVariable("verifyapikey. VerifyAPIKey.app.created_by"));
    • 如果 API Proxy 流程沒有 VerifyAPIKey 政策，您可以使用 AccessEntity 和 ExtractVariables 政策存取 API 產品、開發人員應用程式等的設定檔：
      1. 使用 AccessEntity 政策擷取開發人員應用程式的設定檔： 
        <!-- /antipatterns/examples/2-8.xml -->
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AccessEntity async="false" continueOnError="false" enabled="true" name="GetDeveloperApp">
  <DisplayName>GetDeveloperApp</DisplayName>
  <EntityType value="app"></EntityType>
  <EntityIdentifier ref="developer.app.name" type="appname"/>
  <SecondaryIdentifier ref="developer.id" type="developerid"/>
</AccessEntity>
      2. 使用 ExtractVariables 政策從開發人員應用程式擷取 appId： 
        <!-- /antipatterns/examples/2-9.xml -->
<ExtractVariables name="Extract-Developer App-Info">
  <!--
    The source element points to the variable populated by AccessEntity policy.
    The format is <policy-type>.<policy-name>
    In this case, the variable contains the whole developer profile.
  -->
  <Source>AccessEntity.GetDeveloperApp"</Source>
  <VariablePrefix>developerapp</VariablePrefix>
  <XMLPayload>
    <Variable name="appld" type="string">
      <!-- You parse elements from the developer profile using XPath. -->
      <XPath>/App/AppId</XPath>
    </Variable>
  </XMLPayload>
</ExtractVariables>

延伸閱讀