Integrate with Github Actions
Apidog mendukung menjalankan pengujian otomatis dalam pipeline CI/CD apa pun melalui perintah CLI sederhana. Baik Anda menggunakan GitHub Actions, GitLab CI, Jenkins, maupun handler webhook kustom, Anda dapat memicu pengujian Apidog secara otomatis setiap kali repositori Git Anda diperbarui.Prasyarat#
Akun dan repositori GitHub
Akun Apidog dengan skenario pengujian yang telah dibuat
Akses untuk membuat token akses Apidog
Cara Kerjanya#
Integrasi ini didasarkan pada prinsip sederhana: Git Webhook + Eksekusi CLI.Ketika peristiwa Git (seperti push atau pull request) terjadi, alat CI/CD Anda menerima peristiwa tersebut dan menjalankan perintah apidog run untuk mengeksekusi skenario pengujian Anda.Panduan ini menggunakan GitHub Actions sebagai contoh—karena digunakan secara luas dan tidak memerlukan infrastruktur tambahan. Namun, pendekatan yang sama berlaku untuk platform lain.Penyiapan ini ideal untuk:Menjalankan pengujian API secara otomatis pada setiap push atau pull request
Memantau branch tertentu (misalnya main, develop)
Mendukung pemeriksaan pradeployment dan pengujian regresi
Memastikan eksekusi pengujian yang konsisten dalam workflow CI Anda
Langkah 1: Inisialisasi Workflow GitHub#
1.
Buka GitHub dan masuk ke akun Anda. 2.
Navigasikan ke repositori target Anda.
3.
Klik tab "Actions" di bilah navigasi atas.
4.
Jika ini pertama kalinya Anda menyiapkan Actions di repo tersebut, klik "New workflow" untuk membuatnya.
Langkah 2: Buat Konfigurasi GitHub Actions di Apidog#
1.
Di Apidog, buka proyek Anda dan buka halaman "Tests".
3.
Konfigurasikan lingkungan pengujian, tentukan apakah akan mengaktifkan data pengujian, serta tetapkan jumlah loop dan interval penundaan.
4.
Pilih "GitHub Actions", lalu klik "Copy".
Langkah 3: Tempel dan Commit Workflow di GitHub#
1.
Kembali ke repositori GitHub Anda dan buka halaman Actions.
2.
Buat workflow baru dan tempel kode konfigurasi yang disalin dari Apidog.
3.
Jika Anda sudah memiliki pipeline CI yang ada, Anda dapat menggabungkan konfigurasi pengujian Apidog ke dalamnya.
4.
Klik "Commit changes" untuk menyimpan dan mengaktifkan workflow.
Pastikan untuk mengganti variabel $APIDOG_ACCESS_TOKEN dalam kode dengan Access Token Anda yang sebenarnya. .github/workflows/.
File tersebut merupakan bagian dari kode sumber Anda dan akan disertakan saat Anda mengkloning atau menarik proyek secara lokal. Anda dapat mengeditnya di lingkungan pengembangan lokal Anda dan melakukan commit perubahan melalui Git seperti file lainnya.Bagian atas file workflow berisi baris seperti:Ini memberi tahu GitHub untuk secara otomatis memicu workflow setiap kali seseorang melakukan push kode atau membuka/memperbarui pull request. Ini adalah sintaks singkat yang setara dengan versi yang lebih panjang, dan berfungsi dengan baik untuk sebagian besar skenario CI.Langkah 4: Jalankan Workflow dan Lihat Hasil#
Setelah dikonfigurasi, workflow GitHub Actions akan berjalan secara otomatis setiap kali ada commit kode baru. Anda dapat memantau status workflow dan hasil pengujian di halaman Actions. Modified at 2026-06-11 10:17:04
