การนำเข้า OpenAPI / Swagger
ทำไมต้องใช้การนำเข้า OpenAPI?
หากผลิตภัณฑ์ของคุณถูกสร้างมาสำหรับนักพัฒนา หรือผลิตภัณฑ์ของคุณมี API คุณจำเป็นต้องมีเอกสารประกอบผลิตภัณฑ์ที่ยอดเยี่ยม — ไม่เช่นนั้นคุณจะไม่สามารถเข้าถึงนักพัฒนาได้
เมื่อคุณนำเข้าไฟล์ OpenAPI ของคุณ Archbee จะอ่านและแปลงเป็น UI ที่สวยงามและทำให้พร้อมสำหรับการ:
- แชร์สาธารณะ (บนโดเมนแบบกำหนดเอง)
- ภายในองค์กร กับเพื่อนร่วมงานและทีมของคุณ
เมื่อนำเข้าแล้ว คุณสามารถซิงค์ อัปเดต และทดสอบ OpenAPI ของคุณได้ ดูรายละเอียดเพิ่มเติมในส่วนด้านล่าง
กฎและการตั้งค่าเริ่มต้น
ไฟล์ OpenAPI ที่นำเข้าไม่สามารถแก้ไขได้ด้วยตนเองใน Archbee
หากต้องการอัปเดตและดูแล OpenAPI ของคุณ โปรดตรวจสอบ ตัวเลือกการซิงค์
รองรับเวอร์ชัน OpenAPI:
Archbee รองรับเวอร์ชัน OpenAPI ต่อไปนี้สำหรับการนำเข้า:
- เวอร์ชัน 2.0 และ 2.0.XX
- เวอร์ชัน 3.0 และ 3.0.XX
- เวอร์ชัน 3.1 และ 3.1.XX
รองรับวิธีการยืนยันตัวตน
Archbee รองรับวิธีการยืนยันตัวตนดังต่อไปนี้:
หากคุณนำเข้าไฟล์ OpenAPI ที่มีวิธีการยืนยันตัวตนอื่น ๆ ระบบจะนำเข้าได้ถูกต้อง แต่จะไม่รองรับวิธีการยืนยันตัวตนนั้น
ซึ่งหมายความว่าคุณจะได้รับประสบการณ์การใช้งาน Archbee OpenAPI แบบเต็มรูปแบบ ยกเว้น ฟีเจอร์ Try It! หากเอ็นด์พอยต์ของคุณต้องการการยืนยันตัวตนที่ไม่ได้อยู่ในรายการด้านบน
อื่น ๆ
- หากคุณกำหนดพารามิเตอร์ "default" ใน OpenAPI ของคุณและระบุค่าให้มัน ตัวอย่างโค้ดและช่องพารามิเตอร์จะถูกเติมค่าล่วงหน้าให้อัตโนมัติ สิ่งนี้ทำให้ผู้ใช้หรือลูกค้าของคุณสามารถทดสอบ API ได้ง่ายขึ้นด้วย ลองใช้! โดยไม่ต้องอัปเดตพารามิเตอร์ที่จำเป็นทั้งหมด
- ถ้าคุณกำหนดพารามิเตอร์ "example" ใน OpenAPI ของคุณ ค่า example จะถูกแสดงทางด้านซ้ายถัดจากพารามิเตอร์ของ API สิ่งนี้ช่วยให้ผู้ใช้ของคุณเข้าใจได้ง่ายว่าพารามิเตอร์นั้นต้องการข้อมูลแบบใด
มันทำงานอย่างไร?
นำเข้าไฟล์ OpenAPI ของคุณโดยใช้ Import Content:
หรือใช้ตัวเลือก Import จากแต่ละสเปซ:
หรือซิงก์ไฟล์ OpenAPI ของคุณโดยตรงจาก GitHub repository ของคุณ
ด้วย การผสานรวม GitHub คุณสามารถเพิ่มและซิงก์ไฟล์ OpenAPI จาก repository ของคุณได้โดยตรง
พรีวิวและ ทดสอบ OpenAPI ที่คุณนำเข้า
พรีวิวและทดสอบ OpenAPI ใหม่ที่คุณนำเข้าด้วยฟีเจอร์ API ลองใช้! ของ Archbee
เผยแพร่ หรือ แชร์ ให้เพื่อนร่วมงานหรือผู้ใช้งานของคุณ!
เผยแพร่ไปยัง Preview หรือโดเมนแบบกำหนดเอง และทำให้พร้อมใช้งานสำหรับทีมและผู้ใช้งานของคุณ
หากต้องการปกป้องเนื้อหาและแชร์เฉพาะกลุ่ม โปรดดูตัวเลือก การควบคุมการเข้าถึงสาธารณะ สำหรับพอร์ทัลที่เผยแพร่แล้ว