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