您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
API 供應商必須公開自己的 API、向開發人員介紹 API、申請開發人員及允許開發人員註冊應用程式。Apigee Edge 為您提供開發人員服務入口網站,可用於建構並推出自有自訂網站,為您的開發社群提供這些服務。如要進一步瞭解開發人員入口網站,請參閱「什麼是開發人員入口網站?」一文。
以下各節說明在排解開發人員入口網站問題前,您應瞭解的重要概念。
SmartDocs 的運作方式
說明 API 的 OpenAPI (JSON 或 YAML) 或 WADL 規格可以匯入 SmartDocs,並用於將 API 參考說明文件發布至入口網站。API 參考說明文件會自動顯示在入口網站的「API」分頁下方。開發人員可以透過入口網站查看 API 說明文件,並提出即時 API 要求。由於 API 要求來自瀏覽器,因此需要 CORS (跨源資源共享) 支援才能成功。CORS 支援由 Edge 上的「smartdocs」(位於「VALIDATE」機構單位) 提供,可做為對目標端點的所有 SmartDocs 要求 Proxy。當您安裝 SmartDocs 時,系統會建立「smartdocs」 Proxy。
例如:
Smartdocs Proxy 的網址會以可設定屬性的形式顯示在「Configuration」->「SmartDocs」->「SmartDocs Proxy 網址」中。如果您的 API 位於私人網路,且在入口網站中使用 SmartDocs 的即時 API 要求失敗,您可能需要修改這個網址。
開發人員入口網站如何與 Edge 通訊
開發人員入口網站會從 Edge 儲存及擷取大多數的資訊,包括 Smartdocs、開發人員、產品和開發人員應用程式。您可以透過選單指令「Configuration」(設定) ->「Devportal」(開發人員) 設定邊緣機構資訊和 devadmin 憑證。
詳情請參閱「 在入口網站和邊緣之間通訊」一文。