使用規格編輯器建立規格
您正在查看 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 規格中的兩段簡短摘錄:
驗證規格
規格編輯器會根據 OpenAPI 規範標準驗證您的 OpenAPI 規格。當您輸入時,如果 OpenAPI 規格發生錯誤,規格編輯器的右側窗格會顯示「錯誤」對話方塊,並提供錯誤及其相關行號的詳細資訊,方便您修正。
儲存規格
如要儲存 OpenAPI 規格,請按一下頂端導覽列的「儲存」。
如果這是您第一次儲存規格,系統會提示您輸入檔案名稱。如果不指定檔案名稱,系統會使用「Untitled」。日後您可以重新命名。
關閉規格
如要關閉 OpenAPI 規格,但不想儲存編輯內容,請按一下頂端導覽列的「取消」。您將返回規格清單。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-02-07 (世界標準時間)。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"缺少我需要的資訊"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"過於複雜/步驟過多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"過時"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻譯問題"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/程式碼問題"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"容易理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"確實解決了我的問題"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]
{"lastModified": "\u4e0a\u6b21\u66f4\u65b0\u6642\u9593\uff1a2024-02-07 (\u4e16\u754c\u6a19\u6e96\u6642\u9593)\u3002"}
[[["容易理解","easyToUnderstand","thumb-up"],["確實解決了我的問題","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["缺少我需要的資訊","missingTheInformationINeed","thumb-down"],["過於複雜/步驟過多","tooComplicatedTooManySteps","thumb-down"],["過時","outOfDate","thumb-down"],["翻譯問題","translationIssue","thumb-down"],["示例/程式碼問題","samplesCodeIssue","thumb-down"],["其他","otherDown","thumb-down"]],["上次更新時間:2024-02-07 (世界標準時間)。"],[],[]]