คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
สร้างและตรวจสอบข้อกำหนดของ OpenAPI โดยไม่ต้องเขียนโค้ดใดๆ ด้วยตัวแก้ไขข้อกำหนด
เข้าถึงเครื่องมือแก้ไขข้อกำหนด
เปิดข้อมูลจำเพาะของ OpenAPI ในตัวแก้ไขข้อกำหนดตามที่อธิบายไว้ในส่วนต่อไปนี้
รูปต่อไปนี้แสดงข้อกำหนดของ Petstore API ที่เปิดในตัวแก้ไขข้อกำหนด
ตามที่ได้ไฮไลต์ไว้ในรูปก่อนหน้านี้ ตัวแก้ไขข้อกำหนดจะช่วยให้คุณทำสิ่งต่อไปนี้ได้
- สร้างข้อกําหนดของ OpenAPI เพื่อสร้างรูปแบบ API โดยใช้รูปแบบ JSON หรือ YAML ในแผงด้านซ้าย
- ดูเอกสารประกอบของ API ที่สร้างขึ้นโดยอัตโนมัติในแผงด้านขวา
- ตรวจสอบข้อกำหนดตามมาตรฐาน OpenAPI Specification ขณะที่คุณพิมพ์
- บันทึกข้อกำหนด 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 ให้คลิกบันทึกในแถบนำทางด้านบน
หากบันทึกข้อกำหนดเป็นครั้งแรก ระบบจะขอให้คุณป้อนชื่อไฟล์ หากคุณไม่ระบุชื่อไฟล์ ระบบจะใช้ค่าเริ่มต้นเป็น Untitled คุณสามารถเปลี่ยนชื่อได้ในภายหลัง
ปิดข้อกำหนด
หากต้องการปิดข้อกำหนดของ OpenAPI โดยไม่บันทึกการแก้ไข ให้คลิกยกเลิกในแถบนำทางด้านบน คุณจะถูกนำกลับไปยังรายการข้อกำหนด