คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info
สร้างและตรวจสอบข้อกำหนด OpenAPI โดยไม่ต้องเขียนโค้ดใดๆ โดยใช้เครื่องมือแก้ไขข้อกำหนด
เข้าถึงเครื่องมือแก้ไขข้อมูลจำเพาะ
เปิดข้อกำหนด OpenAPI ในเครื่องมือแก้ไขข้อกำหนดตามที่อธิบายไว้ในส่วนต่อไปนี้
รูปภาพต่อไปนี้แสดงข้อมูลจำเพาะของ Petstore API ที่เปิดอยู่ในเครื่องมือแก้ไขข้อกำหนด
เครื่องมือแก้ไขข้อมูลจำเพาะช่วยให้คุณทำสิ่งต่อไปนี้ได้ดังที่ไฮไลต์ไว้ในรูปภาพก่อนหน้า
- สร้างข้อกำหนด OpenAPI เพื่อจำลอง API โดยใช้รูปแบบ JSON หรือ YAML ในแผงด้านซ้าย
- ดูเอกสารประกอบ API ที่สร้างขึ้นโดยอัตโนมัติในแผงด้านขวา
- ตรวจสอบข้อกําหนดเทียบกับมาตรฐานข้อกําหนด OpenAPI ขณะพิมพ์
- บันทึกข้อกำหนด OpenAPI หรือปิดข้อกำหนดและยกเลิกการแก้ไข
ช่วยฉันเกี่ยวกับ JSON และ YAML
JSON (JavaScript Object Notation) คือรูปแบบการแลกเปลี่ยนข้อมูลที่เบาซึ่งใช้แสดงโครงสร้างข้อมูลและอาร์เรย์ Associative แบบง่าย ดูข้อมูลเพิ่มเติมได้ที่ https://www.json.org
YAML (YAML Ain't Markup Language) คือมาตรฐานการแปลงข้อมูล/การแสดงข้อมูลที่มีไวยากรณ์ซึ่งสามารถแมปกับโครงสร้างข้อมูล เช่น รายการ อาร์เรย์ Associative และค่าสเกลาร์ ดูข้อมูลเพิ่มเติมได้ที่ https://yaml.org
ทั้ง JSON และ YAML เป็นแบบที่เครื่องอ่านได้ แต่ก็อ่านและเข้าใจได้ง่ายสำหรับมนุษย์ รูปภาพต่อไปนี้เปรียบเทียบข้อความสั้นๆ 2 รายการจากข้อกำหนด OpenAPI เดียวกันที่เขียนโดยใช้ JSON และ YAML
ตรวจสอบข้อกําหนด
เครื่องมือแก้ไขข้อกำหนดจะตรวจสอบข้อกำหนด OpenAPI ของคุณเทียบกับมาตรฐานข้อกำหนด OpenAPI ขณะที่คุณพิมพ์ หากมีข้อผิดพลาดในข้อกำหนด OpenAPI เครื่องมือแก้ไขข้อกำหนดจะแสดงกล่องโต้ตอบข้อผิดพลาดที่ด้านบนของแผงด้านขวา และแสดงข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดและหมายเลขบรรทัดที่เชื่อมโยงเพื่อให้คุณแก้ไขข้อผิดพลาดได้อย่างง่ายดาย
บันทึกข้อกําหนด
หากต้องการบันทึกข้อกำหนด OpenAPI ให้คลิกบันทึกในแถบนำทางด้านบน
หากบันทึกข้อกําหนดเป็นครั้งแรก ระบบจะแจ้งให้คุณป้อนชื่อไฟล์ หากไม่ได้ระบุชื่อไฟล์ ระบบจะใช้ "ไม่มีชื่อ" เป็นค่าเริ่มต้น คุณจะเปลี่ยนชื่อได้ในภายหลัง
ปิดข้อกําหนด
หากต้องการปิดข้อกำหนด OpenAPI โดยไม่บันทึกการแก้ไข ให้คลิกยกเลิกในแถบนำทางด้านบน ระบบจะนําคุณกลับไปยังรายการข้อกําหนด