使用範例 API Proxy

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

必要條件

您需要 http://enterprise.apigee.com 的帳戶。您可以在 http://accounts.apigee.com/accounts/sign_up 註冊試用帳戶。

如要使用範例，您也必須具備下列條件：

工具 說明
Git 範例位於 GitHub。如果尚未安裝 Git，請參閱 GitHub 的 Git 設定操作說明。如果不想安裝 Git，可以瀏覽檔案，並從 https://github.com/apigee/api-platform-samples 下載 ZIP 檔案。
Python

您必須安裝 Python，才能執行 Apigee 部署工具。大多數 Linux 環境、已安裝 XCode 的 Mac、已安裝 Cygwin 的 Windows 電腦，以及許多其他地方都有 Python。

如要取得 Python，請參閱 Python 下載頁面。
curl 範例設定指令碼也會使用 curl。確認已安裝 curl，且路徑中提供該指令 (執行 which curl 指令，查看系統是否提供該指令)。
dos2unix 如果您在 Windows 上執行 Cygwin，可能也需要 dos2unix 公用程式。(您可以使用 Cygwin 安裝程式安裝這個公用程式)。

下載範例

如要取得範例檔案，請使用 git clone，如下列範例所示：

git clone https://github.com/apigee/api-platform-samples.git

匯入及部署範例 API Proxy

透過指令列匯入及部署範例：

  1. 下載範例後，請前往 /setup 目錄，如下列範例所示： 
    cd setup
  2. 在 /setup 目錄中，找出 setenv.sh 檔案。
  3. 編輯這個檔案，設定機構、與使用者名稱相關聯的電子郵件地址，以及要部署 API Proxy 的環境 (正式版或測試版)。
  4. 編輯 setenv.sh 後，請執行下列操作： 
    sh deploy_all.sh

    這個指令碼會將所有 API Proxy 範例部署至貴機構。(這個過程需要 3 到 4 分鐘)。按照提示部署 API 產品、開發人員和應用程式 (用於 OAuth)。

  5. 部署指令碼完成後，請前往 sample-proxies 目錄。在 sample-proxies 目錄中，每個範例 Proxy 各有一個目錄。每個目錄中都有 README.md 檔案，內含執行範例的相關資訊，以及兩個可協助您對範例進行小幅變更、部署及叫用範例的指令碼，方便您查看變更的影響：
    • invoke.sh：執行這項指令碼，叫用已部署的 API Proxy 版本。
    • deploy.sh：進行任何變更後，請執行這個指令碼來部署 API Proxy。

叫用範例 API Proxy

每個範例 Proxy 都有相關聯的殼層指令碼，部署後可用於叫用 API Proxy。

在 /sample-proxies/proxy_name 目錄中，執行下列指令：

sh invoke.sh

這會叫用貴機構測試環境中執行的 Proxy。

疑難排解

如需疑難排解資訊，請參閱下列文章：

修改及重複使用範例 API Proxy

範例 Proxy 的一般用途是修改、部署及叫用。您可以進行小幅修改，然後查看這些修改對回覆訊息的影響。

如要修改範例 API Proxy，使其指向其他後端服務，請修改下列位置的 XML 設定檔：

/apiproxy/targets/target_name.xml

舉例來說，如要將 API 金鑰範例指向您自己的後端服務，請找出下列檔案：

/apikey/apiproxy/targets/default.xml

如果預設設定指向 http://mocktarget.apigee.net，例如：

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

後端服務位於 http://api.myproject.com/，請將設定修改為以下內容：

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

儲存變更後，請部署 API Proxy，如下列範例所示：

sh deploy.sh

您可以採用相同方式修改其他 API Proxy，以便針對現有目標服務使用 API Proxy 功能。不過，在某些情況下，API Proxy 行為取決於特定訊息格式，因此 Proxy 可能需要額外的設定變更。