Drupal 型開發人員入口網站疑難排解總覽

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

身為 API 供應商,您需要公開 API、向開發人員說明 API、讓開發人員註冊,以及允許開發人員註冊應用程式。Apigee Edge 提供開發人員服務入口網站,您可使用這個入口網站建構及發布自訂網站,向開發人員社群提供這些服務。如要進一步瞭解開發人員入口網站,請參閱「什麼是開發人員入口網站?」一文。

下列各節將說明重要概念,有助於您排解開發人員入口網站的問題。

SmartDocs 的運作方式

您可以將說明 API 的 OpenAPI (JSON 或 YAML) 或 WADL 規格匯入 SmartDocs,並用來將 API 參考文件發布至入口網站。API 參考說明文件會自動顯示在入口網站的「API」分頁下方。開發人員可透過入口網站探索 API 說明文件,並提出即時 API 要求。由於 API 要求來自瀏覽器,因此需要支援 CORS (跨來源資源共用),才能允許要求成功。Edge 上的「smartdocs」Proxy (位於「VALIDATE」機構中) 會提供 CORS 支援,做為所有 SmartDocs 要求傳送至預期端點的 Proxy。安裝 SmartDocs 時,系統會建立「smartdocs」Proxy。

例如:

SmartDocs Proxy 的網址會顯示為可設定的屬性,位於「Configuration」->「SmartDocs」->「SmartDocs proxy URL」。如果您的 API 位於私人網路,且使用入口網站的 SmartDocs 發出的即時 API 要求失敗,您可能需要修改這個網址。


開發人員入口網站與 Edge 的通訊方式

開發人員入口網站會儲存並擷取 Edge 顯示的大部分資訊,包括 Smartdocs、開發人員、產品和開發人員應用程式。您可以使用「Configuration」->「Devportal」選單指令,設定 Edge 機構資訊和開發管理員憑證。

詳情請參閱「 入口網站與 Edge 之間的通訊」。