หน้าแรก>แหล่งข้อมูลการสร้างเว็บไซต์>ทรัพยากรอื่นๆ
ดาวน์โหลด

openapi-gui

OpenApi-Gui เป็น GUI สำหรับการสร้างและแก้ไขคำจำกัดความ OpenAPI เวอร์ชัน 3.0.x JSON/YAML ในรูปแบบปัจจุบันมีประโยชน์มากที่สุดในฐานะเครื่องมือสำหรับการเริ่มต้นและแก้ไขคำจำกัดความ OpenAPI อย่างง่าย คำจำกัดความ OpenAPI 2.0 ที่นำเข้าจะถูกแปลงเป็น V3.0 โดยอัตโนมัติ

สำหรับเวอร์ชัน Swagger / OpenAPI 2.0 เท่านั้นดูที่นี่ เวอร์ชันนั้น ไม่ได้รับการแก้ไข ในขณะนี้นอกเหนือจากการแก้ไขความปลอดภัย

โครงการนี้เริ่มแรกเป็นส้อมของไอโอโอดอร์ของดาริลคุห์นซึ่งได้รับแรงบันดาลใจจาก Iodoctor โดยแบรนดอนเวสต์ซึ่งเขียนไว้ในทับทิม ประวัติศาสตร์ที่สมบูรณ์ของโครงการได้รับการดูแลใน GitHub

คำอธิบาย

มันทำงานอย่างไร

เลือกคำจำกัดความ OpenAPI 2.0 หรือ 3.0.x ที่มีอยู่เพื่ออัปโหลดหรือสร้างคำจำกัดความใหม่และเริ่มเพิ่มเส้นทางการดำเนินงานและพารามิเตอร์ เมื่อมีการใช้คำจำกัดความที่มีอยู่มันจะถูกแยกวิเคราะห์และแบบฟอร์มสำหรับการแก้ไขแต่ละเส้นทางการดำเนินการและพารามิเตอร์จะถูกสร้างขึ้น

คุณสามารถโหลดคำจำกัดความที่มีอยู่ได้โดยผนวกพารามิเตอร์ A ?url= แบบสอบถามไปยังหน้าเริ่มต้นเริ่มต้นโดยมีค่าเป็น URL ไปยังคำจำกัดความที่คุณต้องการโหลด เมื่อใช้ Docker คุณสามารถตั้งค่าพารามิเตอร์ url Query เป็น %2fserve เพื่อรับคำจำกัดความที่คุณส่งผ่านลงบนคำสั่ง Docker

คลิกรายการจากเมนูทางด้านซ้ายเพื่อเริ่มแก้ไข ดูเอาท์พุท JSON/YAML ได้ตลอดเวลาโดยเลือกแท็บ "ส่งออก" หนึ่งแท็บ เมื่อเสร็จแล้วให้ดาวน์โหลดเอาต์พุตเพื่อบันทึกไว้ในเครื่องหรือคัดลอกคลิปบอร์ดของคุณ Openapi-Gui จัดเก็บคำจำกัดความทีละคำเท่านั้นและนี่คือการจัดเก็บท้องถิ่นของเบราว์เซอร์ของคุณ ตรวจสอบให้แน่ใจว่าคุณบันทึกเอาต์พุต JSON/YAML ของคุณในเครื่อง

ก่อนที่จะดำเนินการทำลายล้าง OpenAPI-GUI จะบันทึกสถานะปัจจุบันของคำจำกัดความ ทุกครั้งที่คุณต้องจำไว้ว่าให้เลือกบันทึกด้วยตนเอง

เทคโนโลยี

OpenApi-Gui ทำงานฝั่งไคลเอ็นต์ทั้งหมดโดยใช้เฟรมเวิร์ก JavaScript จำนวนมากรวมถึง Vue.js, JQuery และ Bulma สำหรับ CSS

เพื่อให้แอปและเรียกใช้เพียงแค่เรียกดูเวอร์ชันสดในหน้า GitHub ให้ปรับใช้โคลนไปยังหน้า GitHub, ปรับใช้กับ Heroku โดยใช้ปุ่มด้านล่างหรือโคลน repo และชี้เบราว์เซอร์ที่ index.html หรือโฮสต์ด้วยตัวคุณเอง - ไม่ง่ายกว่า ข้อมูลทางเทคนิคเพิ่มเติมที่นี่

คุณจะต้อง npm install โมดูล Node.js เท่านั้นหากคุณต้องการใช้เว็บเซิร์ฟเวอร์ Embedded openapi-gui (เช่นไม่ได้หากคุณใช้งานเว็บเซิร์ฟเวอร์ของคุณเอง) มิฉะนั้นจะมีการปรับใช้ PAAS เท่านั้น

ตัวเลือก CLI 

 -d, --definition    serve the given OAS definition
-l, --launch        start a web-browser pointing to the GUI
-p, --port          specify the port to run on, defaults to $PORT or 3000
-w, --write         enable writing back to the source definition

ทำงานกับ Docker

หากคุณไม่มีสภาพแวดล้อมการพัฒนาโหนดท้องถิ่นหรือหากคุณต้องการเรียกใช้ OpenAPI-GUI ในคอนเทนเนอร์ Docker คุณสามารถทำได้ด้วยขั้นตอนง่ายๆ:

  1. โคลนที่เก็บ
  2. เรียกใช้ docker build -t mermade/openapi-gui . เพื่อสร้างภาพนักเทียบท่า ( mermade/openapi-gui )
  3. เรียกใช้ docker run --name openapi-gui -p 8080:3000 -d mermade/openapi-gui เพื่อเรียกใช้เซิร์ฟเวอร์บนพอร์ต 8080
  4. นำทางไปที่ http://localhost:8080 ในเบราว์เซอร์ที่คุณชื่นชอบ
  5. เมื่อเสร็จแล้วให้ปิดเซิร์ฟเวอร์โดยเรียกใช้ docker stop openapi-gui && docker rm openapi-gui

หรือคุณสามารถดึงภาพนักเทียบท่าที่สร้างไว้ล่วงหน้า:

  • docker pull mermade/openapi-gui

ข้อ จำกัด

  • OpenAPI-GUI จะยกเลิกการอ้างอิงพารามิเตอร์ที่ใช้ร่วมกัน
  • คำจำกัดความจะต้องอยู่ในตัวเองโดยไม่มี $ref s ภายนอก สิ่งนี้น่าจะได้รับการแก้ไข (ho-ho) เร็ว ๆ นี้
  • การแก้ไขการตอบสนอง / ตัวอย่าง / สคีมาของร่างกายจะทำการพิจารณา
  • OpenAPI-GUI จะไม่เก็บรักษาผู้ขาย-ส่วนขยายเช่นหากพารามิเตอร์ถูกลบและสร้างใหม่
  • OpenAPI-GUI จะไม่เก็บความคิดเห็นจากคำจำกัดความที่นำเข้าในรูปแบบ YAML

สิ่งที่ต้องทำ

  • ดูรายการสิ่งที่ต้องทำและสถานะปัจจุบันของการสนับสนุนข้อมูลจำเพาะ OpenAPI 3.0
ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด