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