使用規格編輯器建立規格

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

不必使用規格編輯器編寫任何程式碼，就能建立並驗證 OpenAPI 規格。

存取規格編輯器

在規格編輯器中開啟 OpenAPI 規格，如以下各節所述：

下圖顯示了在規格編輯器中開啟的 Petstore API 規格：

如上圖所示，規格編輯器可讓您：

  • 建立 OpenAPI 規格，以在左側窗格中使用 JSON 或 YAML 格式建立 API 模型。
  • 在右側窗格中查看自動產生的 API 說明文件。
  • 根據 OpenAPI 規範標準驗證規格，如您輸入程式碼一樣。
  • 儲存 OpenAPI 規格或關閉規格，然後取消編輯內容。

幫我提供 JSON 和 YAML

JSON (JavaScript Object Notation) 是一種輕量資料交換格式，用來代表簡單的資料結構和關聯陣列。詳情請參閱 https://www.json.org。

YAML (YAML Ain’t 標記語言) 是一種資料序列化/表示法標準，這種標準提供的語法也能對應到清單、關聯陣列和純量等資料結構。詳情請參閱 https://yaml.org。

JSON 和 YAML 兩者都可供機器讀取，但也很容易讓使用者閱讀及理解。下圖比較了使用 JSON 和 YAML 編寫的相同 OpenAPI 規格中的兩段簡短摘錄：

JSON 與 YAML

驗證規格

規格編輯器會根據 OpenAPI 規範標準驗證您的 OpenAPI 規格。當您輸入時，如果 OpenAPI 規格發生錯誤，規格編輯器的右側窗格會顯示「錯誤」對話方塊，並提供錯誤及其相關行號的詳細資訊，方便您修正。

錯誤

儲存規格

如要儲存 OpenAPI 規格，請按一下頂端導覽列的「儲存」。

如果這是您第一次儲存規格，系統會提示您輸入檔案名稱。如果不指定檔案名稱，系統會使用「Untitled」。日後您可以重新命名。

關閉規格

如要關閉 OpenAPI 規格，但不想儲存編輯內容，請按一下頂端導覽列的「取消」。您將返回規格清單。