使用範例 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,例如安裝 XCode 的 Mac、已安裝 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 分鐘才能完成)。按照提示部署 API 產品、開發人員和應用程式 (用於 OAuth)。

  5. 部署指令碼完成後,請前往 sample-proxies 目錄。在 sample-proxies 目錄中,每個範例 Proxy 都會顯示一個目錄。每個目錄中都有一個 README.md 檔案,內有執行範例的相關資訊,以及兩個指令碼,可協助您小幅變更範例、部署並叫用範例,藉此瞭解變更的效果:
    • invoke.sh:執行這個指令碼以叫用 API Proxy 的已部署版本。
    • deploy.sh:在進行任何變更後,執行這個指令碼即可部署 API Proxy。

叫用範例 API Proxy

每個範例 Proxy 都有相關聯的殼層指令碼,您可以在部署 API Proxy 後用於叫用該 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 可能需要其他設定變更。