Cara Menggunakan Apidog CLI di Cursor

Ajari Cursor alur kerja pengujian API Anda dengan file .cursor/rules, lalu minta Agen-nya menjalankan apidog run dan membaca hasilnya. Ditambah server Apidog MCP opsional.

INEZA Felin-Michel

INEZA Felin-Michel

16 June 2026

Cara Menggunakan Apidog CLI di Cursor

Apidog untuk Perusahaan

Penerapan On-Premises

SSO & RBAC

Sesuai SOC 2

Jelajahi Apidog Enterprise

Agen Cursor sudah mengedit file, menjalankan terminal Anda, membaca keluarannya, dan memperbaiki apa yang rusak. Langkah selanjutnya adalah menempatkan pengujian API Anda dalam lingkaran tersebut: biarkan Cursor menjalankan skenario Apidog Anda yang sebenarnya, membaca lulus atau gagal, dan terus berlanjut. Bagian yang membuatnya berfungsi adalah runner baris perintah yang dapat dipanggil oleh Cursor.

Runner itu adalah Apidog CLI, sebuah paket npm bernama apidog-cli. Ini menjalankan skenario pengujian yang Anda buat secara visual di Apidog dari terminal dan keluar dengan kode status yang dapat ditindaklanjuti oleh Cursor. Panduan ini mencakup bagian khusus Cursor: file aturan yang mengajarkan alur kerja Anda kepada Cursor, perintah yang menjalankan pengujian, bagaimana proses jalannya terintegrasi ke dalam loop edit-uji-perbaikan, dan server MCP opsional yang menyerahkan spesifikasi API Anda kepada Cursor saat sedang membuat kode.

Jika CLI belum terinstal, mulailah dengan cara menginstal Apidog CLI dengan agen pengkodean AI, yang memandu Cursor melalui instalasi dan otentikasi. Kembali setelah apidog --version mencetak angka. Anda juga memerlukan akun Apidog dengan setidaknya satu skenario pengujian yang disimpan. Unduh Apidog jika Anda belum memilikinya.

tombol

Apa arti "menggunakan CLI di Cursor"

Tidak ada plugin Apidog untuk Cursor, dan Anda tidak memerlukannya. Agen Cursor sudah menjalankan perintah shell di terminal proyek Anda. Jadi, menggunakan Apidog CLI di Cursor berarti tiga hal:

  1. Ajari Cursor alur kerja sekali saja dengan aturan proyek, sehingga ia mengetahui perintah, flag, dan bahwa kode keluar adalah sumber kebenaran.
  2. Minta Agen menjalankan apidog run sebagai langkah normal dalam loopnya, seperti halnya ia menjalankan unit test Anda.
  3. Secara opsional sambungkan server Apidog MCP, agar Cursor dapat membaca spesifikasi API Anda saat menulis kode yang diuji oleh pengujian tersebut.

Aturan inilah yang membuat ini berbentuk Cursor, bukan panduan generik "buka terminal dan ketik".

Langkah 1: Tambahkan aturan proyek

Cursor membaca aturan proyek dari direktori .cursor/rules di root repo Anda. Setiap aturan adalah file .mdc dengan blok frontmatter kecil, yang dikontrol versinya bersama dengan kode Anda sehingga seluruh tim mendapatkan perilaku yang sama.

Buat salah satu dari dua cara: ketik /create-rule di chat dan jelaskan apa yang Anda inginkan, atau buka Cursor Settings > Rules, Commands, klik + Add Rule. Bagaimanapun Anda akan mendapatkan file di bawah .cursor/rules.

Simpan ini sebagai .cursor/rules/apidog-cli.mdc:

---
description: Cara menjalankan pengujian API Apidog dari terminal
alwaysApply: false
---

# Menjalankan pengujian API Apidog

Proyek ini memiliki skenario pengujian API di Apidog. Jalankan dengan
apidog-cli, yang diinstal secara global dan sudah diautentikasi.

- Perintahnya adalah `apidog run`. Binary-nya adalah `apidog`.
- Jalankan satu skenario berdasarkan ID: `apidog run -t <scenarioId> -e <environmentId> -n 1 -r cli`
  - `-t` adalah ID skenario pengujian, `-e` adalah ID lingkungan.
  - `-n 1` menjalankannya sekali. `-r cli` mencetak laporan yang mudah dibaca ke terminal.
- Jangan berikan `--access-token`. Otentikasi ditangani oleh `apidog login` sebelumnya.
- Kode keluar adalah sumber kebenaran: `0` berarti setiap pernyataan berhasil,
  bukan nol berarti kegagalan. Laporkan kode keluar, bukan hanya ringkasan.
- Jika sebuah flag tidak dikenal, jalankan `apidog run --help` dan gunakan flag yang persis dari sana.
  Jangan pernah menebak nama flag.
- Setelah mengubah kode yang menyentuh endpoint, jalankan skenario yang relevan
  dan baca hasilnya sebelum mengklaim perubahan berfungsi.

Frontmatter itu penting. description ditambah alwaysApply: false membuat ini menjadi aturan yang diterapkan secara cerdas: Cursor menariknya ketika obrolan tentang menjalankan pengujian, daripada menghabiskan konteks pada setiap percakapan. Atur alwaysApply: true untuk selalu menjaganya dalam cakupan. Untuk mencakupnya ke jenis file, hilangkan deskripsi dan tambahkan baris globs, dan Cursor secara otomatis melampirkannya saat file yang cocok terbuka.

Kontennya melakukan pekerjaan nyata. Ini membatasi bentuk perintah, mengatakan dari mana otentikasi berasal, dan menyatakan baris yang menjaga agen tetap jujur: kode keluar menang atas prosa. Agen terkadang membaca laporan yang gagal dan menyebutnya "terlihat bagus". Menulis aturan itu sekali berarti Anda tidak perlu menangkapnya secara manual.

Langkah 2: Dapatkan perintah dari Apidog

Sebelum Anda meminta Agen menjalankan apa pun, dapatkan perintah yang sudah terbukti benar. Jangan biarkan Cursor menebak ID-nya.

Buka skenario pengujian Anda di Apidog, beralih ke tab CI/CD-nya, dan pilih opsi baris perintah. Apidog membangun perintah apidog run lengkap dengan ID skenario, ID lingkungan, dan token akses yang sudah terisi:

apidog run --access-token YOUR_ACCESS_TOKEN -t 605067 -e 1629989 -n 1 -r cli

605067 adalah ID skenario pengujian dan 1629989 adalah ID lingkungan; milik Anda akan berbeda. Karena Anda telah mengautentikasi CLI selama instalasi, hilangkan bagian --access-token dan simpan ID-nya. Itulah perintah yang diperintahkan aturan Anda kepada Cursor untuk digunakan.

Langkah 3: Minta Agen menjalankan pengujian

Buka Agen Cursor (mode obrolan yang menjalankan perintah terminal, bukan pengeditan sebaris). Dengan aturan yang ada, perintahnya pendek:

Jalankan skenario pengujian Apidog saya dan Tunjukkan output lengkapnya dan beritahu kode keluarnya.

Cursor mengusulkan perintah dan, setelah Anda menyetujuinya, menjalankannya di terminal terintegrasi:

apidog run -t 605067 -e 1629989 -n 1 -r cli

Secara default, Cursor bertanya sebelum mengeksekusi perintah terminal, sehingga Anda melihat persis apa yang akan dijalankannya. Setujui, dan Agen akan menjalankan skenario, lalu membaca kembali eksekusi dan ringkasannya.

Pemeriksaan Anda: lihat kode keluar, bukan ringkasan. apidog run keluar 0 ketika setiap pernyataan lulus dan bukan nol ketika ada yang gagal. Perilaku itu adalah alasan utama mengapa ini berfungsi sebagai gerbang, untuk CI dan untuk Agen. Jika Cursor mengatakan "tes berhasil" tetapi kode keluarnya bukan nol, itu salah; percayai kodenya. Ini adalah kegagalan persis yang dicegah oleh aturan Langkah 1.

Untuk format laporan yang berbeda atau iterasi lebih lanjut, minta Agen menjalankan apidog run --help agar ia membaca daftar flag yang sebenarnya untuk versi terinstal Anda. Panduan Apidog CLI lengkap mendokumentasikan setiap flag, termasuk reporter html, json, dan junit serta iterasi berbasis data.

Langkah 4: Baca laporan di dalam Cursor

Reporter -r cli mencetak hasil ke terminal yang sudah dibaca Cursor, yang membuatnya cocok untuk pekerjaan Agen. Agen melihat baris yang sama dengan Anda: skenario mana yang berjalan, setiap permintaan, setiap pernyataan, dan jumlah lulus atau gagal terakhir.

Ketika sebuah eksekusi menjadi merah, laporan tersebut menyebutkan pernyataan yang gagal, nilai yang diharapkan, dan apa yang dikembalikan oleh endpoint. Karena teks itu ada dalam konteks Agen, tindak lanjuti dalam obrolan yang sama:

Skenario gagal. Baca pernyataan yang gagal dalam laporan, temukan handler yang menghasilkan field tersebut, dan usulkan perbaikan. Kemudian jalankan skenario lagi dan tunjukkan kode keluar yang baru.

Sekarang pengujian adalah bagian dari loop. Cursor mengedit handler, menjalankan ulang apidog run, membaca kode keluar yang baru, dan melanjutkan atau mencoba lagi. Pemeriksaan API Anda berada dalam siklus edit-uji-perbaikan yang sama yang digunakan Cursor untuk unit test, kecuali ini berjalan terhadap endpoint yang sebenarnya. Untuk pola yang lebih luas, cara menggunakan agen AI untuk pengujian API mencakup di mana ia cocok dan di mana tidak.

Opsional: sambungkan server Apidog MCP

CLI memungkinkan Cursor untuk menjalankan pengujian Anda. Server Apidog MCP memungkinkan Cursor untuk membaca spesifikasi API Anda saat menulis kode. Keduanya bekerja bersama: server MCP memberi Cursor skema Anda sehingga menghasilkan kode yang sesuai dengan kontrak, dan CLI memverifikasi kode tersebut terhadap skenario nyata.

Cursor mendukung server MCP melalui konfigurasi JSON. Tempatkan server yang cakupannya proyek di .cursor/mcp.json di root repo Anda, atau yang global di ~/.cursor/mcp.json. Bentuknya adalah objek mcpServers yang diberi kunci berdasarkan nama, masing-masing dengan command, array args, dan nilai env opsional:

{
  "mcpServers": {
    "apidog": {
      "command": "npx",
      "args": ["-y", "apidog-mcp-server@latest", "--project=YOUR_PROJECT_ID"],
      "env": {
        "APIDOG_ACCESS_TOKEN": "YOUR_ACCESS_TOKEN"
      }
    }
  }
}

Dua catatan. MCP diatur di belakang tombol sakelar di beberapa instalasi, jadi buka Pengaturan Cursor, temukan bagian Model Context Protocol, dan konfirmasi server Apidog diaktifkan. Dan jika Anda melakukan commit .cursor/mcp.json, jangan hardcode token; referensikan variabel lingkungan. Untuk pengaturan lengkap, termasuk tempat mendapatkan ID proyek dan token, lihat panduan server Apidog MCP. Untuk alur kerja yang terpaket dan dapat digunakan kembali daripada menghubungkannya secara manual, panduan Apidog CLI dengan Claude Skills menunjukkan versi berbasis keterampilan.

Dari loop lokal ke CI

Setelah Cursor menjalankan skenario secara lokal dan bertindak berdasarkan kode keluar, Anda telah memvalidasi perintah persis yang akan digunakan oleh pipeline Anda. Lompatan ke CI kecil: apidog run yang sama, dengan token yang diteruskan sebagai rahasia tersembunyi alih-alih login yang disimpan. Anda bahkan dapat meminta Cursor untuk menulis langkah tersebut, karena ia mengetahui perintah dari aturan Anda:

Mekanisme langkah itu (rahasia, reporter, gating kode keluar) ada di Apidog CLI di GitHub Actions. Perintah yang sama sekarang berjalan di tiga tempat, terminal Anda, loop Agen Cursor, dan CI, semuanya mempercayai kode keluar yang sama.

Hambatan umum

Aturan tidak berlaku. Dengan description dan alwaysApply: false, Cursor hanya memuat aturan ketika ia menilai obrolan itu relevan. Jika sesi pengujian tidak mengambilnya, sebutkan dengan @apidog-cli di obrolan, atau beralih ke alwaysApply: true.

Agen tidak dapat menjalankan perintah. Jika hanya menyarankan perintah daripada menjalankannya, kemungkinan Anda berada dalam mode edit daripada Agen, atau Anda melewatkan prompt persetujuan. Konfirmasikan Anda berada di obrolan Agen dan setujui saat Cursor bertanya. Jika eksekusi terminal gagal sepenuhnya, biasanya masalah PATH apidog: command not found yang dibahas di panduan instalasi.

apidog whoami menunjukkan Anda belum diautentikasi. Login disimpan di mesin Anda, bukan di Cursor. Jalankan apidog login --with-token sendiri dengan token baru dari Apidog, lalu minta Agen untuk mengonfirmasi dengan apidog whoami. Jauhkan token dari obrolan.

Ini menemukan flag. Jika sebuah eksekusi gagal dengan kesalahan "unknown option", Agen menebak sebuah flag yang tidak ada di versi Anda. Minta ia menjalankan apidog run --help dan salin flag yang persis.

Penutup

Penyiapan Cursor adalah satu file dan satu kebiasaan: aturan .cursor/rules/apidog-cli.mdc yang menentukan perintah, sumber otentikasi, dan aturan kode keluar, ditambah kebiasaan membiarkan Agen menjalankan apidog run dan memeriksa kode keluar sendiri. Tambahkan server Apidog MCP dan Cursor juga dapat membaca spesifikasi Anda saat mengkode.

Anda tetap membuat skenario secara visual di Apidog; Cursor hanya menjalankannya. Dari sini, arahkan perintah yang sama ke pipeline Anda dengan Apidog CLI di GitHub Actions, atau baca referensi flag lengkap di panduan Apidog CLI lengkap.

tombol

Mengembangkan API dengan Apidog

Apidog adalah alat pengembangan API yang membantu Anda mengembangkan API dengan lebih mudah dan efisien.