การรวมเอกสาร API จำนวนมากในสภาพแวดล้อม MSA แบบอัตโนมัติ

 (techblog.lycorp.co.jp)
12 คะแนน โดย yechoi 2024-04-29 | 1 ความคิดเห็น | แชร์ทาง WhatsApp
  • ในสภาพแวดล้อม MSA มีปัญหาที่สเปก API เพิ่มขึ้นตามจำนวนโดเมนของบริการ
  • เพื่อแก้ปัญหานี้
    • แสดงเอกสารของบริการหลากหลายรายการในสภาพแวดล้อม MSA ผ่าน URL เดียว
    • ศึกษาวิธีสร้างหน้าเอกสาร API แบบอัตโนมัติ
  • การกำหนดความต้องการและสถาปัตยกรรม
  • เครื่องมือและสเปกที่ใช้ในการรวมเอกสาร API
  • การพัฒนาการรวมเอกสาร API
    • งานโค้ดพื้นฐานเพื่อให้เป็นไปตามสเปก OpenAPI
    • แยกเอกสาร API ออกมาในรูปแบบ JSON
    • เว็บโฮสติ้งด้วย GitHub Pages
    • ทำงานอัตโนมัติด้วย GitHub Actions
  • วิธีนำการรวมเอกสาร API ไปใช้ในสภาพแวดล้อมแบบหลายรีโพซิทอรี

บทความที่เกี่ยวข้อง

1 ความคิดเห็น

 
elijah17 2024-04-30

เพื่อแก้ปัญหาที่คล้ายกันนี้
เรากำลังสร้างเว็บแอปพลิเคชันที่รวบรวมเอกสาร Swagger API แล้วนำมาแสดงอีกครั้งด้วย Swagger UI และเปิดเผยเป็นโอเพนซอร์สอยู่ครับ
https://github.com/stray-cat-developers/giant-otter
เผื่อใครกำลังมีปัญหาในลักษณะใกล้เคียงกัน ก็อาจลองนำไปใช้ดูกันได้ครับ