Mengintegrasikan Banyak Dokumentasi API di Lingkungan MSA Secara Otomatis

 (techblog.lycorp.co.jp)
12 poin oleh yechoi 2024-04-29 | 1 komentar | Bagikan ke WhatsApp
  • Di lingkungan MSA, muncul masalah karena spesifikasi API bertambah sebanyak domain layanan
  • Untuk menyelesaikan masalah ini,
    • menampilkan berbagai dokumen layanan di lingkungan MSA melalui satu URL.
    • memikirkan cara membuat halaman dokumentasi API secara otomatis
  • Definisi kebutuhan dan arsitektur
  • Alat dan spesifikasi yang digunakan untuk integrasi dokumentasi API
  • Implementasi integrasi dokumentasi API
    • Pengerjaan kode dasar untuk memenuhi spesifikasi OpenAPI
    • Mengekstrak dokumentasi API dalam bentuk JSON
    • Web hosting dengan GitHub Pages
    • Otomatisasi menggunakan GitHub Actions
  • Cara menerapkan integrasi dokumentasi API di lingkungan multi-repo

Bacaan terkait

1 komentar

 
elijah17 2024-04-30

Untuk menyelesaikan masalah yang mirip dengan ini,
kami membuat aplikasi web yang mengumpulkan dokumentasi Swagger API lalu menampilkannya kembali melalui Swagger UI, dan membukanya sebagai open source.
https://github.com/stray-cat-developers/giant-otter
Kalau ada yang sedang memikirkan masalah serupa, sepertinya tidak ada salahnya untuk mencobanya.