本頁面由 Cloud Translation API 翻譯而成。

開發工具

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

身為服務供應商，您需開發供用戶端應用程式使用的 API。如要建立、設定和維護 API Proxy 和 API 產品，您可以使用使用者介面或向 API 來存取符合 REST 樣式的服務，如以下各節所述。

使用 Edge UI

Apigee Edge UI 是以瀏覽器為基礎的工具，可用來建立、設定及管理 API Proxy 和 API 產品。部分工作只能透過 API 完成。

下表說明如何存取 Edge UI：

產品	使用者介面名稱	存取網址
Edge	Edge UI	如要存取 Edge UI，請使用以下網址： https://apigee.com/edge 如需使用 Edge UI 的教學課程，請參閱建構第一個 API Proxy。
私有雲適用的 Edge	傳統版 Edge UI	如要存取 Edge for Private Cloud 的 Edge UI，請使用以下網址： http://`ms-ip`:9000 其中 `ms-ip` 是管理伺服器節點的 IP 位址或 DNS 名稱。

產品

使用者介面名稱

存取網址

Edge

Edge UI

如要存取 Edge UI，請使用以下網址：

https://apigee.com/edge

如需使用 Edge UI 的教學課程，請參閱建構第一個 API Proxy。

私有雲適用的 Edge

傳統版 Edge UI

如要存取 Edge for Private Cloud 的 Edge UI，請使用以下網址：

http://ms-ip:9000

其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。

您可以透過 Edge UI 執行下列操作：

透過您的 Proxy 編輯程式碼和追蹤要求流程，即可建立 API Proxy。
建立 API 產品來結合 Proxy，用於向用戶端要求曝光。
管理開發人員和開發人員應用程式。
設定測試和正式環境。
實作 JavaScript 和 Node.js 應用程式。

下圖顯示使用者介面中的 API Proxy 編輯器，可用來建立和設定 API Proxy：

顯示在 Edge UI 的 API Proxy 編輯器中選取的「Develop」(開發) 分頁。

使用 Edge API

您可以使用 Edge API 管理 API 資源。這些 API 也提供一般性功能存取，不會由第一種是使用無代碼解決方案 AutoML 透過使用者介面建立機器學習模型

API 端點通常會接收包含設定資訊的資料，因此需要您傳遞驗證資訊 (例如使用者名稱和密碼) 以存取這些資訊。遵循 REST 樣式您可以運用 HTTP GET、POST、PUT 和任何 API 資源的 DELETE 方法。

如需 Apigee Edge API 的完整清單，請參閱 Apigee Edge API 參考資料。

瞭解 Edge API 基礎路徑

您在 API 要求中使用的路徑可串連下列項目：

包含貴機構名稱的基本路徑。例如： https://api.enterprise.apigee.com/v1/organizations/org_name
端點，指向您正在存取的 Edge 資源。

舉例來說，如果貴機構名稱為「apibuilders」，則每次呼叫 API 將使用下列基本路徑：

https://api.enterprise.apigee.com/v1/organizations/apibuilders

如要擷取貴機構的 API Proxy 清單，您必須在以下位置呼叫 GET：

https://api.enterprise.apigee.com/v1/organizations/apibuilders/apis

許多資源都會限定於環境範圍內。根據預設，系統會提供兩種環境：測試和正式環境舉例來說，快取的範圍是依環境界定。名為「mycache」的共用快取已包含預設元件

您可以呼叫快取資源上的 GET 來列出快取，如下所示：

https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/test/caches
https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/prod/caches

驗證存取權

呼叫 API 時，您必須在 API 伺服器中驗證自己的身分。您可以做的將出現以下其中一種情況：

OAuth2
SAML
基本驗證 (不建議)

此外，Apigee 建議您採用雙重驗證，如啟用 Apigee 帳戶的雙重驗證。

Edge API 限制

每個機構設有以下 Edge API 呼叫費率：

使用付費方案的機構每分鐘 10,000 次呼叫
試用機構每分鐘 600 次呼叫

HTTP 狀態碼 401 和 403 不計入這項限制中。任何超過這些限制的呼叫限制會傳回 429 Too Many Requests 狀態碼。

Edge API 使用提示

本節說明一些使用 Edge API 的技術讓您更容易

縮寫要求網址

建立 Edge API 的要求網址時，您可以使用下列程式碼縮寫：

/e = /environments
/o = /organizations
/r = /revisions

如果您使用縮寫，請務必持續使用縮寫，也就是說，請使用縮寫，路徑，如上所示，如以下範例所示，或者沒有。在同一路徑中同時使用完整與縮寫元素會導致錯誤。

例如：

THIS:
https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/environments/prod/apis/helloworld/revisions/1/deployments
CAN BE MUCH SHORTER:
https://api.enterprise.apigee.com/v1/o/ahamilton-eval/e/prod/apis/helloworld/r/1/deployments

執行 curl 指令

使用 HTTP 用戶端向 API 發出要求。說明文件中的許多範例使用 curl (廣為使用的 HTTP 用戶端) 提供 API 要求範例。如果需要安裝「curl」，請前往以下位置下載： http://curl.haxx.se.

呼叫 API 支援 gzip 壓縮回應。如果您在 API 呼叫中設定了 'Accept-Encoding: gzip, deflate'，超過 1024 個位元組的回應會以 gzip 格式傳回

設定 XML 和 JSON 要求和回應的格式

根據預設，Edge API 會以 JSON 形式傳回資料。對許多要求而言而是以 XML 格式傳回方法是將 Accept 要求標頭設為 application/xml，如以下範例所示：

curl -H "Authorization: Bearer `get_token`" \
  -H "Accept: application/xml" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  | xmllint --format -

回應應如下所示：

<List>
  <Item>SOAP-Message-Validation-1</Item>
  <Item>Spike-Arrest-1</Item>
  <Item>XML-to-JSON-1</Item>
</List>

請注意，本範例使用 prettyprint 顯示結果，方法是透過 xmllint。

acurl 公用程式不支援 Accept 標頭。因此，您可以只會取得含有 acurl 的 JSON 格式回應。

如要將 prettyprint 用於 JSON 回應，您可以使用 json.tool Python 程式庫：

curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer `get_token`" \
  | python -m json.tool

以下提供回應範例：

[
  "SOAP-Message-Validation-1",
  "Spike-Arrest-1",
  "XML-to-JSON-1"
]

如果是 XML，您可以使用 xmllint：

curl https://ahamilton-eval-test.apigee.net/getstarted -u email_address | xmllint --format -

在 XML 中 POST 或 PUTing 酬載時，請使用 Content-type HTTP 標頭：

acurl -H "Content-type:text/xml" -X POST -d \
'<XMLPayload>
 </XMLPayload> ' \
https://api.enterprise.apigee.com/v1/organizations/apifactory/apis -u email_address

部署環境

根據預設，使用 Apigee Edge 的每個機構至少都有兩個可使用的環境開發、測試及部署 API：「測試」和「prod」使用「test」開發及測試環境再公開發布 API只有內部開發人員才能存取 API 部署到測試環境將 API 部署至「正式環境」將其公開也就是應用程式開發人員

偵錯和測試

Apigee 提供追蹤工具，可讓您執行偵錯端對端要求與回應流程追蹤記錄結果會顯示要求和回應標頭，以及酬載、政策執行、變數值，以及流程期間可能發生的任何錯誤。

用於疑難排解的重要資料點：

時間戳記：使用時間戳記查看每個步驟的執行時間長度。比較時間戳記有助於區分執行時間最長的政策降低 API 呼叫的速度
基本路徑：驗證基本路徑，就能確保政策應將郵件轉送到正確的伺服器
政策執行結果：這些結果可供您查看訊息是否使用者會正常變更，例如訊息從 XML 轉換為 JSON，或者系統正在快取訊息

下圖顯示追蹤記錄結果：

顯示在 Edge UI 的 API Proxy 編輯器中選取的「Trace」分頁。

每個追蹤記錄工作階段分成下列主要步驟：

從用戶端收到的原始要求：顯示事件的動詞和 URI 路徑來自用戶端應用程式的要求、標頭、內文資料和查詢參數。
傳送至後端服務的要求：顯示傳送至後端服務的要求訊息。透過 API Proxy 存取後端服務
後端服務傳回的回應：顯示回應標頭以及後端服務傳回的酬載
已傳送至用戶端的最終回應：傳回給要求用戶端應用程式。