Swagger คืออะไร?
บทความนี้อธิบายถึง Swagger คืออะไรและให้คำแนะนำสำหรับผู้เริ่มต้นเกี่ยวกับวิธีใช้ Swagger สำหรับการพัฒนาและเอกสาร API
Introduction to Swagger
Swagger เป็นเครื่องมือที่มีประสิทธิภาพสำหรับการพัฒนา API ที่อำนวยความสะดวกให้ในการออกแบบ สร้าง จัดเก็บเอกสาร และบริโภคเว็บเซอร์วิสแบบ RESTful อย่างง่ายดาย มันได้รับการนำไปใช้กันอย่างแพร่หลายเนื่องจากความสามารถในการให้ความช่วยเหลือในการเข้าถึงเอกสาร API แบบโต้ตอบและความง่ายในการใช้งาน
What is Swagger?
Swagger หรือที่เรียกว่า OpenAPI Specification (OAS) กำหนดมาตรฐานอินเทอร์เฟซที่เป็นภาษาเสรีสำหรับ REST APIs ซึ่งช่วยให้มนุษย์และคอมพิวเตอร์สามารถค้นหาและเข้าใจความสามารถของเซอร์วิสได้โดยไม่ต้องเข้าถึงโค้ดต้นฉบับหรือเอกสารเพิ่มเติม
Core Components of Swagger
- Swagger Editor: เครื่องมือในการเขียนและแสดงเอกสาร API ที่ใช้ในเบราว์เซอร์
- Swagger UI: ชุดของ HTML, JavaScript และ CSS ที่สร้างเอกสารแบบไดนามิกจาก API ที่เป็นไปตามมาตรฐาน Swagger
- Swagger Codegen: เครื่องมือใช้สร้างไลบรารีของไคลเอ็นต์ สตับเซิร์ฟเวอร์ เอกสาร API และการกำหนดค่าอัตโนมัติ
How Swagger Works
Swagger ทำงานโดยใช้รูปแบบ JSON หรือ YAML ที่เฉพาะเจาะจงเพื่ออธิบายรายละเอียดของ API รวมถึงจุดปลายทาง รูปแบบของการร้องขอและการตอบกลับ วิธีการรับรองตนเอง และอื่นๆ รูปแบบนี้จะถูกนำมาใช้สำหรับการสร้างเอกสารแบบโต้ตอบและเครื่องมือสร้างโค้ด
Getting Started with Swagger
ในการเริ่มต้นใช้ Swagger คุณจะต้องกำหนด API ของคุณในไฟล์สเปคของ Swagger ตัวอย่างพ