JSON SchemaตัวOpenAPIแปลงออนไลน์
JSON SchemaการOpenAPIย้ายโมเดลข้อมูลของคุณระหว่างมาตรฐานต่างๆ อาจเป็นงานที่ยุ่งยากและต้องทำด้วยตนเอง เครื่องมือแปลงของเราจะทำให้กระบวนการนี้เป็นไปโดยอัตโนมัติ ช่วยให้คุณสามารถแปลงJSON Schemaคำจำกัดความมาตรฐานให้เป็น รูปแบบที่เข้ากันได้กับ OpenAPIข้อกำหนด(OAS)ได้ทันที ไม่ว่าคุณจะสร้างเอกสาร Swagger หรือกำหนดเนื้อหาคำขอ/การตอบกลับ เครื่องมือนี้รับประกันความถูกต้องและการปฏิบัติตามข้อกำหนด
เหตุใดจึงควรเปลี่ยนJSON Schemaมาใช้OpenAPI?
แม้ว่าOpenAPI(เดิมชื่อ Swagger) จะใช้ชุดย่อยของ แต่JSON Schemaก็มีความแตกต่างที่สำคัญในวิธีการจัดการคำหลักบางคำ เช่นtype, nullable, และformatระหว่างเวอร์ชันต่างๆ(Draft 4, 7 หรือ 2019-09) และOpenAPIข้อกำหนด 3.0/3.1
การเชื่อมช่องว่างด้านความเข้ากันได้
OpenAPIเวอร์ชัน 3.0 มีข้อจำกัดเฉพาะที่แตกต่างจากมาตรฐานJSON Schemaตัวแปลงของเราจัดการกับความแตกต่างเหล่านี้ เช่น การแปลงdependenciesเป็นตรรกะที่เข้ากันได้ หรือการปรับtypeอาร์เรย์ให้ตรงตามOpenAPIข้อกำหนดที่เข้มงวดของเวอร์ชัน 3.0 เพื่อให้มั่นใจว่าเอกสาร API ของคุณยังคงถูกต้อง
ปรับปรุงกระบวนการพัฒนา API ให้มีประสิทธิภาพยิ่งขึ้น
แทนที่จะเขียนโมเดลฐานข้อมูลหรือสคีมาการตรวจสอบความถูกต้องใหม่สำหรับเอกสาร API ของคุณ คุณสามารถคัดลอกโค้ดที่มีอยู่แล้วได้เลยJSON Schemaวิธีนี้ช่วยลดข้อผิดพลาดจากมนุษย์และทำให้ตรรกะแบ็กเอนด์และเอกสารของคุณสอดคล้องกันอย่างสมบูรณ์แบบ
คุณสมบัติหลักของตัวแปลงของเรา
เครื่องมือของเราได้รับการออกแบบมาสำหรับนักพัฒนาที่ต้องการความแม่นยำและความเร็วในการจัดการข้อกำหนด API
1. รองรับการสร้างJSON Schemaร่างเอกสาร หลายฉบับ
ไม่ว่าสคีมาต้นทางของคุณจะอิงตามร่างฉบับที่ 4, 7 หรือ 2020-12ระบบของเราจะระบุโครงสร้างและจับคู่กับโครงสร้างที่ใกล้OpenAPIเคียง ที่สุด
2. OpenAPI3.0 และ 3.1 พร้อมใช้งาน
OpenAPIเวอร์ชัน 3.1 สามารถใช้งานร่วมกับJSON Schemaเวอร์ชัน 2019-09 ได้อย่างสมบูรณ์แล้ว อย่างไรก็ตาม หากคุณยังคงใช้OpenAPIเวอร์ชัน 3.0 อยู่ เครื่องมือของเราจะทำการ "ลดระดับ" ฟิลด์บางส่วนโดยอัตโนมัติ(เช่นnullable: trueแทนที่จะเป็นtype: ["string", "null"]) เพื่อรักษาความเข้ากันได้
3. การตรวจสอบและจัดรูปแบบทันที
โปรแกรมนี้ไม่เพียงแต่แปลงข้อมูลเท่านั้น แต่ยังช่วยจัดรูปแบบผลลัพธ์ให้สวยงามอีกด้วย คุณจะได้OpenAPIโครงสร้างข้อมูลที่สะอาด เป็นระเบียบ และถูกต้อง พร้อมที่จะนำไปวางในcomponents/schemasส่วน ของคุณได้ทันที
วิธีใช้งานโปรแกรมแปลงไฟล์
วางโค้ดของคุณ:คัดลอกโค้ดของคุณJSON Schemaลงในช่องแก้ไขข้อมูล
เลือกเวอร์ชัน(ไม่บังคับ):เลือกWว่าคุณต้องการให้ผลลัพธ์ได้รับการปรับให้เหมาะสมสำหรับOpenAPIมาตรฐาน 3.0 หรือมาตรฐาน 3.1 ที่ใหม่กว่า
คลิกที่ปุ่มแปลง:เครื่องมือจะประมวลผลตรรกะและแสดงผลลัพธ์ที่สอดคล้องกับมาตรฐาน OpenAPI ในหน้าต่างเอาต์พุต
คัดลอกและใช้งาน:ใช้ปุ่ม "คัดลอก" เพื่อคัดลอกสคีมาใหม่ไปใช้กับเอกสาร Swagger หรือ Redocly ของคุณ
ความแตกต่างทางเทคนิคที่ควรระวัง
การจัดการทรัพย์สินที่ "สามารถยกเลิกได้"
ในมาตรฐานJSON Schemaฟิลด์ที่อนุญาตค่าว่างมักถูกกำหนดเป็น `null` type: ["string", "null"]ในOpenAPIเวอร์ชัน 3.0จะต้องแปลงเป็น ` null` type: stringโดยใช้คุณสมบัติแยกต่างหากnullable: trueตัวแปลงของเราจัดการเรื่องนี้โดยอัตโนมัติ
คำหลัก "รูปแบบ"
OpenAPIใช้formatคำหลักในการตรวจสอบความถูกต้องอย่างกว้างขวางมากขึ้น(เช่น, int32, int64,) เครื่องมือของเราช่วยให้มั่นใจ floatได้doubleว่ารูปแบบเหล่านี้จะถูกเก็บรักษาไว้และแมปอย่างถูกต้องในระหว่างการแปลง
คำถามที่พบบ่อย(FAQ)
ตัวแปลงนี้ใช้งานร่วมกับ Swagger 2.0 ได้หรือไม่?
แม้ว่าจุดเน้นจะอยู่ที่เวอร์ชันOpenAPI3.x แต่สคีมาที่สร้างขึ้นส่วนใหญ่เข้ากันได้กับ Swagger 2.0 แม้ว่าdefinitionsอาจต้องมีการปรับแต่งบางส่วน ในบางจุดก็ตาม
ข้อมูลของฉันจะถูกส่งออกจากเบราว์เซอร์หรือไม่?
ไม่เลย การแปลงข้อมูลทั้งหมดเกิดขึ้นในเบราว์เซอร์ของคุณโดยใช้ JavaScript ข้อมูล API ที่ละเอียดอ่อนของคุณจะไม่ถูกส่งไปยังเซิร์ฟเวอร์ของเราแต่อย่างใด
ฉันสามารถแปลงสคีมาขนาดใหญ่และซับซ้อนได้หรือไม่?
ใช่แล้ว เครื่องมือของเราได้รับการปรับแต่งให้สามารถจัดการกับโครงสร้างข้อมูลแบบซ้อนกันหลายชั้นและคำจำกัดความของอ็อบเจ็กต์ขนาดใหญ่ได้โดยไม่ทำให้ประสิทธิภาพลดลง