您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
使用規格編輯器，不必編寫任何程式碼即可建立及驗證 OpenAPI 規格。
存取規格編輯器
在規範編輯器中開啟 OpenAPI 規範，如以下各節所述：
下圖顯示在規格編輯器中開啟的 Petstore API 規格：
如上圖所示，規格編輯器可讓您：
- 在左側窗格中，使用 JSON 或 YAML 格式建立 OpenAPI 規格，以便建立 API 模型。
- 在右側窗格中查看系統自動產生的 API 說明文件。
- 輸入內容時，請根據 OpenAPI 規範標準驗證規格。
- 儲存 OpenAPI 規範，或關閉規範並取消編輯。
請協助我使用 JSON 和 YAML
JSON (JavaScript Object Notation) 是一種輕量資料交換格式，用於表示簡單資料結構和關聯陣列。詳情請參閱 https://www.json.org。
YAML (YAML Ain't Markup Language) 是一種資料序列化/表示標準，提供可對應至資料結構的語法，例如清單、關聯陣列和標量。如需瞭解詳情，請參閱 https://yaml.org。
JSON 和 YAML 都是機器可讀的格式，但也能讓人類輕鬆閱讀及理解。下圖比較了同一份 OpenAPI 規格中使用 JSON 和 YAML 編寫的兩個簡短摘錄：
驗證規格
規格編輯器會根據 OpenAPI 規格標準驗證 OpenAPI 規格。在您輸入內容時，如果 OpenAPI 規格中出現錯誤，規格編輯器會在右側窗格頂端顯示「錯誤」對話方塊，並提供錯誤和相關行號的詳細資訊，方便您輕鬆修正錯誤。
儲存規格
如要儲存 OpenAPI 規格，請按一下頂端導覽列中的「儲存」。
如果這是您第一次儲存規格，系統會提示您輸入檔案名稱。如果未指定檔案名稱，系統會預設為「Untitled」。之後可以重新命名。
關閉規格
如要關閉 OpenAPI 規格而不儲存編輯內容，請按一下頂端導覽列中的「取消」。您會返回規格清單。