使用範例 API Proxy

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

必要條件

您必須在 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 都有 Python 環境、已安裝 Cygwin 的 Windows 電腦，以及許多其他位置。

如需取得 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 個 minutes.)按照提示部署 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 進行額外的設定變更。