maira-cli
MairaCLI adalah alat pengembang yang dirancang untuk secara otomatis menghasilkan dokumentasi swagger untuk endpoint dengan mencegat permintaan dan respons saat menguji endpoint API.
Terdaftar dalam kategori:
Alat PengembangKategoriSumber Terbuka
Deskripsi
MairaCLI adalah alat pengembang yang dirancang untuk secara otomatis menghasilkan dokumentasi Swagger untuk endpoint API dengan mencegat permintaan dan respons selama pengujian.
Cara menggunakan maira-cli?
Untuk menggunakan MairaCLI, instal melalui npm, mulai server proxy di dalam proyek backend Anda, konfigurasikan detail yang diperlukan di file config.json, dan buat permintaan ke backend Anda melalui server proxy. Setelah membuat permintaan, hasilkan dokumentasi menggunakan perintah yang disediakan.
Fitur inti dari maira-cli:
1️⃣
Secara otomatis menghasilkan dokumentasi Swagger untuk endpoint API
2️⃣
Mencegat permintaan dan respons untuk dokumentasi yang akurat
3️⃣
Membuat file konfigurasi untuk rute proyek
4️⃣
Menghasilkan tautan pratinjau dokumentasi
5️⃣
Mendukung header otentikasi kustom
Mengapa bisa digunakan maira-cli?
| # | Kasus Penggunaan | Status | |
|---|---|---|---|
| # 1 | Menghasilkan dokumentasi API untuk proyek backend | ✅ | |
| # 2 | Menguji endpoint API sambil mendokumentasikannya | ✅ | |
| # 3 | Membuat dokumentasi Swagger untuk mikroservis | ✅ | |
Dikembangkan oleh maira-cli?
MairaCLI dikembangkan oleh komunitas kontributor di GitHub, bertujuan untuk menyederhanakan proses dokumentasi API bagi pengembang.