發布 API (原始版本)

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

將 API 發布至入口網站，供應用程式開發人員使用，如以下各節所述。

API 發布總覽

將 API 發布至入口網站的程序包含兩個步驟：

1. 選取要發布至入口網站的 API 產品。
2. 根據 OpenAPI 規範的快照自動產生 API 參考說明文件，協助應用程式開發人員瞭解您的 API。(如要進一步瞭解快照，請參閱「什麼是 OpenAPI 規範的快照？」一文。

將 API 發布至入口網站後，系統會自動對入口網站進行以下更新：

• 您的入口網站已新增 API 參考資料頁面
  「API 參考資料」頁面會顯示 API 參考說明文件，您是透過 OpenAPI 規範的快照自動產生該文件。開發人員可以查看您的 API 說明文件，然後按一下「試用」提出 API 要求，並查看輸出內容。

  注意：您無法直接編輯這個頁面的內容，這類內容不會顯示在入口網站的頁面清單中。

  

• API 頁面中會新增 API 參考資料頁面連結
  API 頁面 (隨附於範例入口網站) 會列出已發布至入口網站的所有 API，並提供個別 API 參考說明文件的連結，進一步瞭解詳情。

  注意：您無法直接編輯這個頁面的內容，這類內容不會顯示在入口網站的頁面清單中。

  

什麼是 OpenAPI 規格快照？

每項 OpenAPI 規格都是 API 生命週期的可靠資料來源。API 生命週期 (從開發、發布到監控) 的各個階段都會採用相同的規格。修改規格時，您必須瞭解變更所帶來的其他生命週期階段，對 API 造成的影響。詳情請參閱「修改規格會有什麼影響？」一節

發布 API 時，您可以擷取 OpenAPI 規範的快照，產生 API 參考說明文件。這個快照代表規格儲存庫中的特定規格版本。如果您用規格編輯器比較 OpenAPI 規格，您可以考慮再拍攝一份規格快照，以反映 API 參考文件的最新變更。

為 API Proxy 新增 CORS 支援

在發布 API 之前，您必須在 API Proxy 中新增 CORS 支援，以支援用戶端跨來源要求。

CORS (跨來源資源共享) 是一種標準機制，允許在網頁中執行的 JavaScript XMLHttpRequest (XHR) 呼叫，可與來自非來源網域的資源互動。CORS 是一種常見解決方案，適用於各種瀏覽器強制執行的同源政策。舉例來說，如果您透過瀏覽器上執行的 JavaScript 程式碼向 Twitter API 發出 XHR 呼叫，呼叫就會失敗。這是因為網頁傳送至瀏覽器的網域與 Twitter API 的網域不同。CORS 為解決這個問題，可讓伺服器在想提供跨來源資源共享的情況下自行「選擇加入」。

如要瞭解如何在發布 API 前為 API Proxy 新增 CORS 支援，請參閱在 API Proxy 中新增 CORS 支援。

注意：大多數新式瀏覽器會強制執行 CORS。查閱完整的支援的瀏覽器清單。如需 CORS 的詳細說明，請參閱跨源資源共享 W3C 建議。

瀏覽 API 頁面

如要存取 API 頁面：

1. 依序選取 [發布] > [入口網站]，然後選取您的入口網站。
2. 按一下入口網站首頁的「API」。

您也可以在頂端導覽列的入口網站下拉式選單中選取「API」。

系統隨即顯示 API 清單。

如上圖所示，API 頁面可讓您：

• 查看入口網站上可用的 API 詳細資料
• 在入口網站中新增 API
• 拍攝與 API 產品相關聯的 OpenAPI 規範快照，藉此更新 API 參考說明文件
• 在入口網站上發布或取消發布 API
• 在入口網站上管理 API 的目標對象
• 編輯相關聯的規格 (請參閱「使用規格編輯器建立規格」)
• 從入口網站中移除 API
• 快速找出已從 Edge 中移除相關聯 API 產品的「孤立」 API，然後重新建立 API 產品或將 API 從入口網站中刪除

在入口網站中新增 API

注意：您在入口網站中最多可以新增 100 個 API。

如何在入口網站中新增 API：

1. 依序選取 [發布] > [入口網站]，然後選取您的入口網站。
2. 按一下入口網站首頁的「API」。
   您也可以在頂端導覽列的入口網站下拉式選單中選取「API」。
3. 按一下「+ API」。
   系統會顯示「將 API 產品新增至入口網站」對話方塊。

4. 在對話方塊的「API Product」分頁中，選取要新增至入口網站的 API 產品。
   

5. 點選「下一步」。

6. 選取要用於快照的來源。
   如果您使用 OpenAPI 規範建立 API 產品中包含的 API Proxy，請從下拉式清單中選取規格。
   

   您也可以選取：

   • 無規格，並在 API 發布後新增。如「取得規格快照」一節所述。
   • 選擇其他規格，選取或上傳新規格。

7. 勾選「已發布」核取方塊，將 API 發布至入口網站。如果尚未準備好發布 API，請取消選取「已發布」。
   您之後可以按照「在入口網站上發布或取消發布 API」的說明變更設定。

8. 在「目標對象」下方，選取下列任一選項，以授予下列項目來管理 API 目標對象：

   • 匿名使用者：允許所有使用者查看網頁。
   • 已註冊的使用者：僅允許已註冊的使用者查看頁面。

   您日後可以按照「在入口網站上管理 API 的目標對象」一文的說明變更設定。

9. 按一下「Finish」。

拍攝規格快照

發布 API 後，您隨時可以取用新的 OpenAPI 規範相片，更新在入口網站上發布的 API 參考文件。

如要拍攝 OpenAPI 規格的快照：

1. 依序選取 [發布] > [入口網站]，然後選取您的入口網站。
2. 按一下入口網站首頁的「API」。
   您也可以在頂端導覽列的入口網站下拉式選單中選取「API」。
3. 將遊標移到您要拍攝快照的 API 上，即可顯示動作。

4. 按一下 。

   注意：如果快照目前符合所選來源規格，則系統會顯示訊息。

5. 從「Snapshot Source」下拉式選單中選取現有規格，或是選取「選擇其他規格」，選取或上傳要用於產生 API 說明文件的新規格。你也可以選取「No spec」(無規格)，移除目前的規格。

6. 按一下「更新快照」 (如果您選取「無規格」，請按一下「移除快照」)。

API 參考說明文件是根據規格產生，並新增至 API 參考資料頁面。

在入口網站上發布或取消發布 API

如何在入口網站上發布或取消發布 API：

1. 依序選取 [發布] > [入口網站]，然後選取您的入口網站。
2. 按一下入口網站首頁的「API」。
   您也可以在頂端導覽列的入口網站下拉式選單中選取「API」。
3. 將遊標移到您要發布或取消發布的 API 上。
4. 按一下 。
5. 勾選「已啟用」核取方塊，即可在入口網站上發布 API。取消選取「已啟用」即可取消發布 API。
6. 按一下「儲存」。

在入口網站上管理 API 的目標對象

授予下列項目的存取權，以便在入口網站上管理 API 的目標對象：

• 所有使用者
• 僅限已註冊的使用者

如要在入口網站上管理 API 的目標對象，請按照下列步驟操作：

1. 依序選取 [發布] > [入口網站]，然後選取您的入口網站。
2. 按一下入口網站首頁的「API」。
   您也可以在頂端導覽列的入口網站下拉式選單中選取「API」。
3. 將遊標移到您要用來管理目標對象的 API 上，即可顯示動作。
4. 按一下 。
5. 在「目標對象」下方，選取下列其中一個選項：
   • 匿名使用者：允許所有使用者查看 API 產品。
   • 已註冊的使用者：僅允許已註冊的使用者查看 API 產品。
6. 按一下「儲存」。

從入口網站中移除 API

如何從入口網站中移除 API：

1. 依序選取 [發布] > [入口網站]，然後選取您的入口網站。
2. 按一下入口網站首頁的「API」。
   您也可以在頂端導覽列的入口網站下拉式選單中選取「API」。
3. 將遊標移到清單中的 API 上，即可顯示動作選單。
4. 按一下「」。

排解已發布 API 的相關問題

使用「試試看」功能時，如果傳回 TypeError: Failed to fetch 錯誤，請考慮以下可能的原因和解決方法：

• 如果是混合內容錯誤，可能是因為已知的 swagger-ui 問題導致錯誤。其中一種可能的解決方法，是確認您已在 OpenAPI 規格的 schemes 定義中，先指定 HTTPS 再指定 HTTP。範例說明如下：

   schemes:
     - https
     - http
  

• 如果是 CORS (跨來源資源分享) 限制錯誤，請確認 API Proxy 支援 CORS。 CORS 是一種標準機制，可用於啟用用戶端跨來源要求。請參閱為 API Proxy 新增 CORS 支援。同時務必在瀏覽器中啟用 CORS。