คืออะไร OpenAPI
ข้อกำหนดสำหรับอธิบาย REST API
OpenAPI เป็นข้อกำหนดมาตรฐานสำหรับอธิบาย REST API ช่วยให้สร้างเอกสารและโค้ดอัตโนมัติได้
ข้อดีของ OpenAPI
- มาตรฐานการอธิบาย API แบบรวม
- เอกสารสร้างอัตโนมัติ
- การสร้างโค้ดฝั่งไคลเอนต์
- การตรวจสอบคำขอและการตอบกลับ
ส่วนประกอบหลัก
- Info — ข้อมูลเมตาของ API
- Paths — จุดปลายทางและการดำเนินการ
- Components — สคีมาที่ใช้ซ้ำได้
- Security — วิธีการยืนยันตัวตน
- Servers — URL พื้นฐาน
เครื่องมือ
- Swagger UI — เอกสารแบบโต้ตอบ
- Swagger Editor — ตัวแก้ไขข้อกำหนด
- OpenAPI Generator — การสร้างโค้ด
- Redoc — เอกสารทางเลือก