您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
本主題說明如何從指令列部署 Proxy。Apigee Edge 提供兩種從指令列部署的選項。第一種是使用以 Python 編寫的 Apigee Edge 部署工具。另一種方法是設定及執行殼層指令碼。
直接在系統上處理 Proxy 來源檔案時,請使用指令列部署技術。您可能因為許多原因而離線工作。您可能想使用喜愛的 XML 編輯器,或是開發需要 Java 程式碼的政策,並主要在 IDE 中工作。本節所述技術可讓您將來源檔案上傳及部署至所選的 API 服務環境。
如果您主要使用管理 UI,請參閱「在 UI 中部署 Proxy」。
您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
執行 Apigee Edge Python 部署工具
Apigee Edge Python 部署工具可與 Edge 管理 API 搭配運作,匯入及部署 API Proxy。這項工具是 GitHub 上 API Platform Samples 發行版本的一部分。請參閱「使用範例 API Proxy」。
使用 Apigee Edge Python 工具,透過簡單的程序匯入 (上傳) 及部署 API。
您必須從 API Platform Samples 發布套件的根目錄執行部署工具,而根目錄是 setup 和 tools 目錄的上層目錄。
在下列指令中,請替換 Proxy 名稱、Edge 使用者名稱和密碼、Edge 機構和環境,以及包含 API Proxy「apiproxy"」目錄的目錄路徑:
python tools/deploy.py -n proxyname -u name:passW -o org -e env -d proxypath -p /
例如:
python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p /
這個指令會將檔案壓縮為 ZIP 格式,然後推送至 Apigee Edge 上的機構,並部署至指定環境。
部署工具會自動探索 API Proxy 的目前修訂版本、取消部署現有修訂版本,並部署 API Proxy 的遞增修訂版本。
成功後,您會看到以下格式的輸出內容:
Writing ./<proxybasedir>/apiproxy/weatherapi.xml to apiproxy/weatherapi.xml Writing ./<proxybasedir>/apiproxy/proxies/default.xml to apiproxy/proxies/default.xml Writing ./<proxybasedir>/apiproxy/targets/default.xml to apiproxy/targets/default.xml Imported new proxy version 1 Environment: test Revision: 1 BasePath = / State: deployed
根據預設,這項工具會將 API Proxy 上傳至 https://api.enterprise.apigee.com,也就是對應於雲端 Edge 的位置。您也可以使用這項工具,透過指定 -h 旗標,將 API Proxy 上傳至 Edge 的地端部署版本:
python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p / -h https://192.168.11.111:8080
在本範例中,您指定 Edge 管理伺服器的 IP 位址。如果您已為管理伺服器建立 DNS 記錄,可以指定下列格式的網址:
https://ms_URL:8080
以下是指令的完整旗標清單:
-n:API Proxy 的名稱。-u:您在 Apigee Edge 機構中的帳戶使用者名稱和密碼。-o:您擁有帳戶的機構名稱。-e:API Proxy 的部署環境 (test或prod)。-d:包含 API Proxy 檔案的目錄路徑。API Proxy 檔案必須儲存在名為「apiproxy」的目錄下。這個值是包含「apiproxy」目錄的目錄路徑,而非「apiproxy」目錄本身的路徑。-p:用來做為模式比對的 URI 路徑,可將傳入訊息轉送至這個 API Proxy 部署作業。在大多數情況下,您可以將這個值設為「/」,除非您有進階部署和轉送需求。API Proxy 路由使用的主要路徑,是在 API Proxy 的 ProxyEndpoint 設定檔中定義。-h:Edge 網址。根據預設,網址為https://api.enterprise.apigee.com,對應於雲端中的 Edge。如果是地端部署,請使用 Edge 管理伺服器的網址和通訊埠 8080,如下所示:https://ms_URL:8080
或者,使用管理伺服器的 IP 位址,如
https://192.168.11.111:8080所示。
設定及執行部署 Shell 指令碼
最簡單的方法是執行範例 API Proxy 隨附的部署指令碼。這些殼層指令碼會包裝 Apigee Edge Python 部署工具。
從 /simplyProxy 目錄執行:
$ sh deploy.sh
如下所示:
Enter your password for user {myname} in the Apigee Enterprise organization {org_name}, followed by [ENTER]:
輸入密碼,然後按下 ENTER 鍵。
接著,您應該會看到:
Deploying to test on https://api.enterprise.apigee.com using {myname} on enterprise.apigee.com and {org_name} on enterprise.apigee.com如果看到下列訊息:
Enter your password for user Your USERNAME on enterprise.apigee.com in the Apigee Enterprise organization Your ORG on enterprise.apigee.com, followed by [ENTER]:
這表示您需要修改平台範例發布中的 /setup/setenv.sh 檔案。如需操作說明,請參閱 README 或 Apigee Edge API。
成功後,部署工具會將 /apiproxy, 中的檔案壓縮為 ZIP 格式,然後將套件匯入 Apigee Edge 上的機構,並將 API Proxy 部署至「test」環境。
API Proxy 已可供叫用。