管理規格

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

Apigee Edge 可讓您儲存 OpenAPI 規格。依照以下各節所述的方式管理您的 OpenAPI 規格。

如要進一步瞭解 OpenAPI 規範,請參閱「什麼是 OpenAPI 規範?」一文。

查看規格清單

如何存取規格清單:

  1. 登入 apigee.com/edge
  2. 選取機構。
  3. 在側邊導覽選單中,依序選取「Develop」(開發) >「Specs」(規格)

系統會顯示目前的規格和資料夾清單。

規格清單

如上圖所示,在規格清單中您可以:

建立新的 OpenAPI 規格

如何建立新的 OpenAPI 規格:

  1. 在側邊導覽列中,依序按一下「開發」>「規格」
  2. 按一下「+ 規格」
  3. 在下拉式選單中按一下「New Spec」。規格編輯器隨即會開啟。
  4. 請將範例規格改成您自己的 OpenAPI 規格詳細資料。
    請參閱「使用規格編輯器建立規格」。
  5. 按一下「儲存」以儲存規格。
  6. 在系統提示時輸入規格名稱。
  7. 點按「儲存」

匯入 OpenAPI 規格

如何匯入 OpenAPI 規格:

  1. 在側邊導覽列中,依序按一下「開發」>「規格」
  2. 按一下「+ 規格」
  3. 在下拉式選單中點選下列其中一個選項:
    • 匯入網址以從網址匯入規格。收到系統提示時,請指定名稱和網址。
    • 匯入檔案來瀏覽本機目錄來查看規格。
      規格隨即會新增至清單中。
  4. 按一下規格名稱,即可在規格編輯器中查看及編輯規格。
    請參閱「使用規格編輯器建立規格」。

編輯現有的 OpenAPI 規格

如何開啟現有的 OpenAPI 規格:

  1. 在側邊導覽列中,依序按一下「開發」>「規格」
  2. 在規格清單中,按一下與規格相關聯的資料列。
  3. 在規格編輯器中編輯規格。
    請參閱「使用規格編輯器建立規格」。

從規格清單中的規格建立 API Proxy

有了 Apigee Edge,您就可以透過規格編輯器設計並儲存的 OpenAPI 規格建立 API Proxy。只要按幾下滑鼠,即可在 Apigee Edge 中設定 API Proxy,以及系統自動產生的路徑、參數、條件流程和目標端點。接著,您可以新增 OAuth 安全性、頻率限制和快取等功能。

透過 OpenAPI 規範建立 API Proxy 後,如果規格經過修改,您必須手動修改 API Proxy 來反映您實作的變更。請參閱「修改規格會有什麼影響?」一節。

如何透過規格清單中的 OpenAPI 規格建立 API Proxy:

  1. 在側邊導覽選單中,依序選取「Develop」(開發) >「Specs」(規格)
  2. 視需要前往包含 OpenAPI 規格的資料夾。
  3. 將遊標移到您想要建立 API Proxy 以顯示動作選單的 OpenAPI 規格上。
  4. 按一下 產生 Proxy。開啟「建立 Proxy」精靈後,系統已根據 OpenAPI 規格中的值預先填入 Proxy 詳細資料頁面,如下圖所示。
    建構 Proxy 精靈
  5. 點選「下一步」
  6. 按照透過 OpenAPI 規範建立 API Proxy 所述,逐步完成「建立 Proxy」精靈的其餘頁面。(從步驟 8 開始)。

重新命名規格

如何重新命名規格:

  1. 在側邊導覽選單中,依序選取「Develop」(開發) >「Specs」(規格)
  2. 如有需要,請前往包含規格的資料夾。
  3. 將遊標移到您要重新命名的規格上,即可顯示動作選單。
  4. 按一下「重新命名規格」。
  5. 編輯規格名稱。
  6. 按一下「重新命名」即可儲存編輯內容,按一下「取消」即可取消。

將規格移至資料夾

您可以將規格整理到資料夾中,以便進行管理和確保安全性。如要將規格移至資料夾,請參閱使用資料夾管理規格

刪除規格

如果不再需要規格或規格無效,可以從檔案儲存區刪除。

如何刪除規格:

  1. 在側邊導覽選單中,依序選取「Develop」(開發) >「Specs」(規格)
  2. 將遊標移到要刪除的規格上,即可顯示動作選單。
  3. 按一下 刪除圖示
  4. 在系統提示時按一下「Delete」(刪除),確認刪除作業。
  5. 刪除不再需要的相關構件。