MSA ortamındaki çok sayıdaki API dokümanını otomatik olarak birleştirmek

 (techblog.lycorp.co.jp)
12 puan yazan yechoi 2024-04-29 | 1 yorum | WhatsApp'ta paylaş
  • MSA ortamında, servis alanı sayısı kadar API spesifikasyonu oluşması sorunu ortaya çıkar
  • Bu sorunu çözmek için,
    • MSA ortamındaki çeşitli servis dokümanlarını tek bir URL'de göstermek ve
    • API doküman sayfalarını otomatik olarak oluşturma yöntemini ele alma
  • Gereksinimlerin tanımı ve mimari
  • API dokümanı birleştirmede kullanılan araçlar ve spesifikasyonlar
  • API dokümanı birleştirme uygulaması
    • OpenAPI spesifikasyonunu karşılamak için temel kod çalışması
    • API dokümanlarını JSON formatında dışa aktarma
    • GitHub Pages ile web barındırma
    • GitHub Actions kullanarak otomasyon
  • Çoklu repo ortamında API dokümanı birleştirmesini uygulama yöntemi

İlgili okumalar

1 yorum

 
elijah17 2024-04-30

Benzer bir sorunu çözmek için
Swagger API dokümanlarını toplayıp bunları yeniden Swagger UI üzerinden gösteren bir web uygulaması geliştirip açık kaynak olarak yayımlıyoruz.
https://github.com/stray-cat-developers/giant-otter
Benzer bir konuda kafa yoranlar varsa, denemeleri iyi olabilir.