Swag Doc
SwagDoc secara otomatis menghasilkan dokumentasi Swagger/OpenAPI dari lalu lintas API Anda tanpa memerlukan perubahan kode.
Terdaftar dalam kategori:
ProduktivitasAlat PengembangKategori
Deskripsi
SwagDoc secara otomatis menghasilkan dokumentasi Swagger/OpenAPI dari lalu lintas API Anda tanpa memerlukan perubahan kode. Ini menangkap dan menganalisis permintaan dan respons HTTP sebagai proxy untuk menyimpulkan struktur API, tipe data, dan skema, sehingga dokumentasi API menjadi mudah.
Cara menggunakan Swag Doc?
Untuk menggunakan SwagDoc, atur sebagai proxy di depan API Anda dengan menjalankan perintah 'swagdoc proxy --port 8080 --target http://yourapiserver.com'. Ini akan memulai server proxy yang menangkap lalu lintas untuk dokumentasi. Setelah menangkap lalu lintas, hasilkan dokumentasi Swagger/OpenAPI menggunakan 'swagdoc generate --output swagger.json'.
Fitur inti dari Swag Doc:
1️⃣
Bertindak sebagai proxy untuk menangkap lalu lintas API
2️⃣
Menganalisis permintaan dan respons HTTP untuk menyimpulkan struktur API
3️⃣
Secara otomatis mendeteksi tipe data, parameter, dan skema respons
4️⃣
Menghasilkan dokumentasi OpenAPI/Swagger berdasarkan lalu lintas yang diamati
5️⃣
Tidak ada perubahan kode yang diperlukan untuk API Anda yang ada
Mengapa bisa digunakan Swag Doc?
| # | Kasus Penggunaan | Status | |
|---|---|---|---|
| # 1 | Secara otomatis mendokumentasikan API tanpa memodifikasi kode | ✅ | |
| # 2 | Dengan mudah menghasilkan spesifikasi OpenAPI untuk API yang ada | ✅ | |
| # 3 | Mengorganisir dokumentasi API ke dalam kelompok logis berdasarkan jalur URL | ✅ | |
Dikembangkan oleh Swag Doc?
SwagDoc dikembangkan oleh komunitas kontributor dan bersifat sumber terbuka, memungkinkan kolaborasi dan perbaikan dari pengembang di seluruh dunia.