OpenAPI Specification
OAS 3.1.1 Released!
ข้อมูลจำเพาะ OpenAPI เป็นข้อกำหนด Open ที่ขับเคลื่อนด้วยชุมชนภายในโครงการ OpenAPI Initiative ซึ่งเป็นโครงการความร่วมมือของมูลนิธิ Linux
ข้อมูลจำเพาะ OpenAPI (OAS) กำหนดคำอธิบายอินเตอร์เฟสภาษาและการเขียนโปรแกรมมาตรฐานสำหรับ HTTP APIs สิ่งนี้ช่วยให้ทั้งมนุษย์และคอมพิวเตอร์สามารถค้นพบและทำความเข้าใจความสามารถของบริการโดยไม่ต้องเข้าถึงซอร์สโค้ดเอกสารเพิ่มเติมหรือการตรวจสอบการรับส่งข้อมูลเครือข่าย เมื่อกำหนดอย่างถูกต้องผ่าน OpenAPI ผู้บริโภคสามารถเข้าใจและโต้ตอบกับบริการระยะไกลที่มีตรรกะการใช้งานจำนวนน้อยที่สุด เช่นเดียวกับคำอธิบายอินเทอร์เฟซที่ทำสำหรับการเขียนโปรแกรมระดับต่ำกว่าข้อกำหนดของ OpenAPI จะลบการคาดเดาในการเรียกใช้บริการ
ใช้กรณีสำหรับเอกสารคำจำกัดความ API ที่สามารถอ่านได้ด้วยเครื่อง แต่ไม่ จำกัด เฉพาะ: เอกสารเชิงโต้ตอบ; การสร้างรหัสสำหรับเอกสารลูกค้าและเซิร์ฟเวอร์ และระบบอัตโนมัติของกรณีทดสอบ เอกสาร OpenAPI อธิบายบริการ API และแสดงในรูปแบบ Yaml หรือ JSON เอกสารเหล่านี้อาจถูกสร้างขึ้นและให้บริการแบบคงที่หรือสร้างขึ้นจากแอปพลิเคชันแบบไดนามิก
ข้อมูลจำเพาะ OpenAPI ไม่จำเป็นต้องเขียน API ที่มีอยู่ใหม่ ไม่จำเป็นต้องเชื่อมโยงซอฟต์แวร์ใด ๆ กับบริการ - บริการที่อธิบายไว้อาจไม่ได้เป็นเจ้าของโดยผู้สร้างคำอธิบาย อย่างไรก็ตามมันต้องการให้ความสามารถของบริการอธิบายไว้ในโครงสร้างของข้อกำหนดของ OpenAPI ไม่สามารถอธิบายบริการทั้งหมดได้โดย OpenAPI - ข้อกำหนดนี้ไม่ได้มีวัตถุประสงค์เพื่อครอบคลุมทุกรูปแบบของ HTTP APIs แต่รวมถึงการสนับสนุนสำหรับ REST API ข้อกำหนดของ OpenAPI ไม่ได้สั่งกระบวนการพัฒนาที่เฉพาะเจาะจงเช่นการออกแบบก่อนหรือรหัสก่อน มันช่วยอำนวยความสะดวกทั้งสองอย่างโดยการสร้างปฏิสัมพันธ์ที่ชัดเจนกับ HTTP API
โครงการ GitHub นี้เป็นจุดเริ่มต้นสำหรับ OpenAPI ที่นี่คุณจะพบข้อมูลที่คุณต้องการเกี่ยวกับข้อกำหนดของ OpenAPI ตัวอย่างง่ายๆของสิ่งที่ดูเหมือนและข้อมูลทั่วไปบางอย่างเกี่ยวกับโครงการ
พื้นที่เก็บข้อมูลนี้มีแหล่งมาร์เดอร์ดาวน์สำหรับเวอร์ชันข้อกำหนดของ OpenAPI ที่เผยแพร่ทั้งหมด สำหรับบันทึกย่อการเปิดตัวและรุ่นผู้สมัครให้อ้างอิงหน้าเผยแพร่
แต่ละโฟลเดอร์ในที่เก็บนี้เช่น schemas และการทดสอบควรมีโฟลเดอร์ที่เกี่ยวข้องกับข้อมูลจำเพาะรุ่นปัจจุบันและรุ่นก่อนหน้า
หากคุณต้องการเห็นมันใช้งานได้ให้ตรวจสอบรายการตัวอย่างปัจจุบัน
กำลังมองหาวิธีที่คุณสามารถสร้างนิยาม OpenAPI ของคุณเองนำเสนอหรือใช้งานได้อย่างไร? ตรวจสอบรายการการใช้งานที่เพิ่มขึ้น
กระบวนการปัจจุบันสำหรับการพัฒนาข้อกำหนดของ OpenAPI ได้อธิบายไว้ในแนวทางการสนับสนุน
การพัฒนาข้อกำหนดของ OpenAPI เวอร์ชันถัดไปนั้นได้รับคำแนะนำจากคณะกรรมการกำกับดูแลด้านเทคนิค (TSC) กลุ่มผู้มอบอำนาจนี้นำความเชี่ยวชาญ API ของพวกเขารวมข้อเสนอแนะจากชุมชนและขยายกลุ่มของผู้มอบอำนาจตามความเหมาะสม กิจกรรมการพัฒนาทั้งหมดในข้อกำหนดในอนาคตจะดำเนินการเป็นคุณสมบัติและรวมเข้ากับสาขานี้ เมื่อเปิดตัวสเปคในอนาคตสาขานี้จะถูกรวมเข้ากับ main
TSC จัดการประชุมเว็บรายสัปดาห์เพื่อตรวจสอบคำขอดึงแบบเปิดและหารือเกี่ยวกับปัญหาเปิดที่เกี่ยวข้องกับข้อมูลจำเพาะ OpenAPI ที่พัฒนาขึ้น การมีส่วนร่วมในการโทรรายสัปดาห์และการประชุมที่กำหนดเวลาเปิดให้ชุมชน คุณสามารถดูปฏิทินการประชุมทางเทคนิค OpenAPI ทั้งหมดออนไลน์
OpenAPI Initiative ส่งเสริมการมีส่วนร่วมจากบุคคลและ บริษัท เหมือนกัน หากคุณต้องการมีส่วนร่วมในวิวัฒนาการของข้อกำหนด OpenAPI ให้พิจารณาดำเนินการดังต่อไปนี้:
ข้อเสนอแนะทั้งหมดไม่สามารถรองรับได้และอาจมีข้อโต้แย้งที่มั่นคงสำหรับหรือต่อต้านการเปลี่ยนแปลงที่เหมาะสมสำหรับข้อกำหนด
ดู: ใบอนุญาต (Apache-2.0)
