หากคุณยังไม่ได้ใช้ภาษาคำจำกัดความสำหรับข้อกำหนด API ที่เครื่องอ่านได้ เช่น OpenAPI (เดิมเรียกว่า Swagger) คุณควรพิจารณาทำเช่นนั้น ท้ายที่สุดแล้ว API ก็คือภาษาสำหรับเครื่องที่ใช้พูดคุยกัน
Swagger เป็นความคิดที่ดีไหม
Swagger สร้างความประทับใจแรกพบที่ดี นอกจากนี้ หลายคนคิดว่าความเป็นไปได้ในการสร้างรหัสจากเอกสารประกอบเป็นความคิดที่ดีและ Swagger ให้ข้อมูลนั้น เช่นกัน. ดังนั้นความจริงที่ว่าการโอ้อวดสร้างความประทับใจแรกพบที่ดี ทำให้ข้อจำกัดและข้อจำกัดไม่ชัดเจน
จุดประสงค์ของการใช้ Swagger คืออะไร
Swagger ช่วยให้คุณสามารถอธิบายโครงสร้างของ API ของคุณเพื่อให้เครื่องสามารถอ่านได้ ความสามารถของ API ในการอธิบายโครงสร้างของตัวเองคือรากฐานของความยอดเยี่ยมใน Swagger
Swagger ยังใช้อยู่หรือเปล่า
วันนี้ ผู้ใช้จำนวนมากยังคงใช้คำว่า " Swagger" เพื่ออ้างถึงรูปแบบข้อกำหนด OpenAPI 2.0 และ "ข้อกำหนด Swagger" เพื่ออ้างถึงเอกสารคำอธิบาย API ในรูปแบบนี้. RepreZen API Studio ใช้ข้อกำหนดเหล่านี้ในบางส่วนของ UI แต่อ้างถึง OpenAPI 3.0 และเวอร์ชันที่ใหม่กว่าเป็น "OpenAPI "
กร่างสำหรับ REST API เท่านั้นหรือไม่
ข้อกำหนด OpenAPI (เดิมชื่อ Swagger Specification) คือ รูปแบบคำอธิบาย API สำหรับ REST API ไฟล์ OpenAPI ช่วยให้คุณอธิบาย API ทั้งหมดของคุณได้ ซึ่งรวมถึง: ตำแหน่งข้อมูล (/users) ที่ใช้งานได้ และการดำเนินการในแต่ละจุดปลาย (GET /users, POST /users)