OpenAPI 3.1.0 ได้รับการอัปเดตที่เข้ากันได้กับ JSON Schema, การสนับสนุนเว็บฮุค และการแก้ไขด้านความสวยงาม
เพียงหนึ่งปีหลังจาก OAS 3.0.3 เปิดตัว — และห้าเดือนหลังจาก OAS 3.1.0 RC1’s — OAS 3.1.0 ได้เข้าสู่คลื่นวิทยุในที่สุด นี่คือการแก้ไขครั้งใหญ่ล่าสุดของ OpenAPI Initiative สำหรับสาขา OAS 3.0 อย่างไรก็ตามเรื่องนี้ นักพัฒนาข้อกำหนดต้องการให้การอัปเกรดรู้สึกเพิ่มขึ้นสำหรับผู้ใช้ใหม่ ผู้ใช้ในองค์กรที่พึ่งพา OAS ควรรู้สึกสบายใจกับการปรับใช้อย่างรวดเร็ว แม้ว่าแบบแผนการตั้งชื่อเชิงความหมายจะบังคับให้ต้องข้ามไปยัง OAS 4.0 แต่การก้าวกระโดดจะไม่สนับสนุนการยอมรับการเปลี่ยนแปลงที่สำคัญอย่างรวดเร็ว
ในขณะที่กลุ่มบริษัทมีการพัฒนาที่ก้าวหน้าอยู่เสมอ การเผยแพร่มักจะห่างกันเป็นเดือนหรือหลายปี ผู้ใช้ควรคุ้นเคยกับงานสร้างล่าสุดนี้ โชคดีที่มีสินค้าที่อัปเดตมากมายสำหรับนักพัฒนาที่จะแกะกล่อง มีอะไรเปลี่ยนแปลงอย่างแน่นอน?
ความเข้ากันได้ของ JSON Schema ที่สมบูรณ์
การเปลี่ยนแปลงภายใต้พาดหัวร่ม JSON Schema รุ่นใหม่ OAS นี้ JSON เป็นรูปแบบเริ่มต้นสำหรับเอกสาร OpenAPI (นอกเหนือจาก YAML) และมีความสำคัญอย่างมากสำหรับนักพัฒนาทั่วโลก น่าเสียดายที่ข้อบกพร่องในการสนับสนุนและการกำหนดมาตรฐานที่ไม่แน่นอนได้ขัดขวางประโยชน์ของ JSON Schema และโครงสร้างข้อมูลที่คล้ายกัน ส่วนขยายสคีมาเป็นผลผลิตจากวิธีการต่างๆ มากมาย
OAS 3.1.0 แก้ปัญหาเหล่านี้ได้ 100% ด้วยความเข้ากันได้ 100% กับฉบับร่างล่าสุดของ JSON Schema (2020–12) เวอร์ชันนี้เน้นการสร้างมาตรฐานส่วนขยายสคีมา การรวมคำศัพท์ใหม่ช่วยเสริมการมุ่งเน้นตามมาตรฐานนี้ ซึ่งส่งผลต่อกระบวนการต่างๆ เช่น การสร้างโค้ด การพัฒนา UI และเอกสารประกอบ เนื่องจาก OpenAPI เองสนับสนุนการเขียนโปรแกรมมาตรฐานสำหรับ API สมัยใหม่ การเปลี่ยนแปลงนี้จึงมีความเกี่ยวข้องทั้งในด้านปรัชญาและการทำงาน JSON Schema จะยังคงเป็นแนวทางที่เป็นประโยชน์สำหรับการตรวจสอบความถูกต้อง
หมายเหตุ: คำศัพท์สคีมาเหล่านี้เรียกว่า “schema dialects” ภายในเวอร์ชันที่เผยแพร่
คำอธิบายการอัปโหลดไฟล์มีการเปลี่ยนแปลงในขั้นตอนล็อกด้วยการพัฒนา JSON Schema ใหม่ OpenAPI Initiative เตือนว่านี่อาจเป็นการเปลี่ยนแปลงครั้งใหญ่ แม้แต่ภายในโครงสร้างที่เสถียร โดยรวมแล้ว การผสานรวมกับ JSON Schema ที่มากขึ้นทำให้เกิดโอกาสในการกำหนดพฤติกรรมที่ดีขึ้นภายใน OAS ดังนั้น การเพิ่มjsonSchemaDialectฟิลด์ระดับบนสุดอำนวยความสะดวกในการประกาศค่าเริ่มต้นสำหรับออบเจกต์ Schema
คำอธิบายเว็บฮุคที่ดีขึ้น
หลายบริษัทใช้เว็บฮุคเพื่อแชร์ข้อมูลระหว่างแอปพลิเคชัน เว็บฮุคเหล่านี้จำนวนมาก (เช่นที่ใช้โดย Stripe และ GitHub เป็นต้น) ได้รับการพัฒนาขึ้นเอง อย่างไรก็ตาม ไม่สามารถจัดการได้บนเครือข่ายองค์กรเสมอไป
เครือข่ายนี้อาจมีการหยุดทำงานเป็นครั้งคราว เนื่องจากไม่มีระบบนิเวศใดที่จะใช้งานได้ 100% เว็บฮุคเซิร์ฟเวอร์และเซิร์ฟเวอร์ที่ใช้ประโยชน์จากตัวกลางเหล่านี้ต้องจัดการจากระยะไกลตามความจำเป็น สิ่งนี้มีความเกี่ยวข้องอย่างยิ่งในสภาพอากาศในปัจจุบัน เว็บฮุคเหล่านี้จึงได้รับการจัดการจากวงดนตรี การพิจารณา Webhooks พิเศษเหล่านี้มีความสำคัญเท่าเทียมกัน เนื่องจากส่งข้อมูลและผลักดันกิจกรรมด้วยวิธีที่ไม่เหมือนใคร
OAS 3.1.0 แนะนำองค์ประกอบระดับบนสุดใหม่เพื่ออธิบายเว็บฮุคนอกวง เช่นเดียวกับเว็บฮุคที่ลงทะเบียนภายนอก นักพัฒนาสามารถอธิบายพารามิเตอร์ วัตถุประสงค์ และการโต้ตอบของเว็บฮุคแต่ละรายการ นอกเหนือจากสิ่งที่สร้างขึ้นโดยอัตโนมัติ API ใช้งานฟังก์ชันนี้ภายใต้ OAS มาระยะหนึ่งแล้ว
คำอธิบายอาจยาวหรือสั้น นอกจากนี้ บางอ็อบเจ็กต์อนุญาตให้มีการสรุป การเปลี่ยนแปลงตามคำอธิบายถูกสร้างขึ้นเพื่อเพิ่มความชัดเจนของเอกสาร — ในขณะที่ให้บริบทมากขึ้นสำหรับแต่ละเทคโนโลยีที่เป็นปัญหา
กล่าวสวัสดีกับการระบุมาตรฐาน
ในเวอร์ชัน OAS ก่อนหน้านี้ การระบุอ็อบเจ็กต์ใบอนุญาตสำหรับ API ที่เปิดเผยมีสองส่วน : ชื่อและ URL ฟิลด์เหล่านี้เป็นสตริงทั้งสอง ชื่อใบอนุญาตสำหรับ API แต่ละรายการเป็นสิ่งจำเป็น ในขณะที่ URL ใดๆ ของใบอนุญาต API จะต้องอยู่ในรูปแบบ URL ออบเจ็กต์ใบอนุญาตยังสามารถขยายได้ภายใต้ข้อกำหนด
OAS 3.1.0 รองรับการระบุใบอนุญาต API ผ่านตัวระบุ SPDX มาตรฐานแล้ว มาตรฐาน SPDX ใช้ License List ซึ่งแคตตาล็อกชื่อใบอนุญาตแบบเต็ม ตัวระบุ เสรีภาพของ FSF และการอนุมัติ OSI ด้วยเหตุนี้จึงมีข้อยกเว้นใบอนุญาตและตัวระบุที่สั้นลงสำหรับซอร์สโค้ดของคุณ
มาตรฐาน SPDX ยังใช้ไฟล์ข้อมูลที่สะอาดกว่าและอ่านได้ด้วยเครื่อง URL ที่รวมไว้เป็น URL ตามรูปแบบบัญญัติและถาวร ดังนั้นจึงไม่มีความเสี่ยงในการใช้ลิงก์ที่เสียหาย มาตรฐาน SPDX มีอายุการใช้งาน ซึ่งหมายความว่าส่วนประกอบบางอย่างอาจมีค่าเสื่อมราคาหรือเปลี่ยนใหม่เมื่อเวลาผ่านไป มาตรฐานการระบุตัวตนที่ได้รับการสนับสนุนนี้ได้รับการสนับสนุนโดย Linux Foundation
นำกลับมาใช้ใหม่ได้ง่ายขึ้น
อPathItemsอบเจ็กต์นี้เป็นทางเลือกภายใต้ OAS 3.1.0 ก่อนหน้านี้ ผู้ใช้บางคนบ่นว่าแนวทางปฏิบัติที่ดีที่สุดไม่ชัดเจนในการจัดเก็บพาธภายนอกหรือการอ้างอิง นอกจากนี้ $ref ฟิลด์ยังไม่เพียงพอสำหรับการอ้างอิงและเก็บรายการพาธในส่วนประกอบ การขาดองค์ประกอบที่ใช้ซ้ำได้ PathItems หมายความว่า $ref คุณสมบัติต้องชี้ไปที่ทรัพยากรภายนอก บางครั้งก็ยุ่งยาก นอกจากนี้ยังทำให้เอกสารสามารถจัดการได้น้อยลง
นำกลับมาใช้ใหม่ PathItems ได้ในขณะนี้สามารถอธิบายได้ใน components วัตถุ ข้อดีคือการสร้างไลบรารีส่วนประกอบที่ใช้ซ้ำได้ง่ายกว่า นอกจากนี้ API ที่ใช้ใบรับรองความปลอดภัยของไคลเอ็นต์อาจมีคำอธิบายเพื่อเพิ่มความโปร่งใส
การเปลี่ยนแปลงเบ็ดเตล็ด
เช่นเดียวกับการเปิดตัวใหม่ใดๆ ก็ตาม ให้ความสำคัญกับการล้างข้อมูลเป็นอย่างมาก OAS 3.1.0 ได้ทำงานเพื่อแก้ไขปัญหาที่จู้จี้มากมายที่ยังค้างอยู่ในเวอร์ชัน 3.0.3 และเวอร์ชันก่อนหน้า ลิงก์บางลิงก์มีตำแหน่งที่แม่นยำยิ่งขึ้น ดังนั้น URI และ URL จึงมีความละเอียดในการอ้างอิงที่ปรับปรุงใหม่ คำนำหน้าส่วนขยายข้อมูลจำเพาะบางรายการได้รับการสงวนไว้สำหรับคำจำกัดความของ OpenAPI Initiative
สุดท้าย มีการเพิ่มคำชี้แจงจำนวนหนึ่งรอบค่าพารามิเตอร์ ออบเจ็กต์อ้างอิง ตัวอย่างเอกสาร คำอธิบาย และมาตรฐานการตั้งชื่อ
โดยรวมแล้ว การอัปเดตล่าสุดของ OAS นำการเปลี่ยนแปลงคุณภาพชีวิตมากมายมาสู่ปาร์ตี้ Initiative ระบุว่าคำติชมของนักพัฒนามีบทบาทสำคัญในการกำหนดลำดับความสำคัญและการแก้ไข ขอแนะนำให้ผู้ใช้อัปเกรดโดยรับประกันว่าจะไม่ใช่ภารกิจสำคัญ และไม่จำเป็นต้องปรับปรุงครั้งใหญ่
หากต้องการดูคุณสมบัติใหม่ใน OAS 3.1.0 ให้ละเอียดยิ่งขึ้น โปรดชมผู้มีส่วนร่วมของ OpenAPI Darrel Miller และ Ron Ratovsky แนะนำการอัปเดตที่นี่:
ทั้งนี้บริษัทเคแอนด์โอ จึงได้มุ่งเน้นการจัดการแก้ไขปัญหา จัดการเอกสาร ด้านเอกสารขององค์กรมาอย่างยาวนาน และ ให้ความสำคัญกับด้านงานเอกสาร ต่อลูกค้าเป็นอย่างดี จนถึงปัจจุบันก็ได้ความยอมรับจากองค์กร ขนาดใหญ่ ขนาดกลาง และขนาดเล็กมากมาย จึงใคร่ขออาสาดูและปัญหาด้านเอกสารให้กับองค์กรของท่านอย่างสุดความสามารถ เพราะเราเป็นหนึ่งในธุรกิจ ระบบจัดเก็บเอกสาร ที่ท่านไว้ใจได้
สอบถามได้สบายใจทั้ง เรื่องค่าบริการ ราคา และ งบประมาณ เพราะเป็นราคาที่สุด คุ้มที่สุด
เรามีแอดมินคอยคอบคำถาม 24 ชั้วโมงที่ Line OA ให้คำปรึกษาด้านวางระบบจัดการเอกสารอิเล็กทรอนิกส์ EDMS โดยทีมงานผู้เชี่ยวชาญจาก K&O
ที่มีประสบการณ์มากว่า 15 ปี รวมถึงซอฟต์แวร์ระดับโลก ติดต่อ 0 2 – 8 6 0 – 6 6 5 9 หรือ E m a i l : c s @ k o . i n . t h
หากท่านมีความสนใจ บทความ หรือ Technology สามารถติดต่อได้ตามเบอร์ที่ให้ไว้ด้านล่างนี้
Tel.086-594-5494
Tel.095-919-6699
