Apidog Docs
🇮🇩 Bahasa Indonesia
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇮🇩 Bahasa Indonesia
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇮🇩 Bahasa Indonesia
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. Apidog CLI
  • Pusat Pembelajaran Apidog
  • Memulai
    • Pengantar Apidog
    • Konsep Dasar di Apidog
    • Menavigasi Apidog
    • Mulai cepat
      • Ikhtisar
      • Membuat Endpoint
      • Membuat Permintaan
      • Menambahkan Aservi
      • Membuat Skenario Pengujian
      • Membagikan Dokumentasi API
      • Jelajahi Lebih Lanjut
    • Migrasi ke Apidog
      • Ikhtisar
      • Impor Manual
      • Impor Terjadwal (Ikat Sumber Data)
      • Opsi Impor
      • Ekspor Data
      • Impor dari
        • Impor dari Postman
        • Impor Spesifikasi OpenAPI
        • Impor cURL
        • Impor Markdown
        • Impor dari Insomnia
        • Impor dari apiDoc
        • Impor File .har
        • Impor WSDL
  • Data API mock
    • Ikhtisar
    • Smart Mock
    • Mock Kustom
    • Urutan Prioritas Mock
    • Mock Scripts
    • Cloud Mock
    • Mock Runner Self-Hosted
    • Bahasa Mock (Lokal)
  • Akun dan preferensi
    • Pengaturan Akun
    • Membuat Token Akses OpenAPI
    • Notifikasi
    • Pengaturan Bahasa
    • Tombol Pintas
    • Konfigurasi Proxy Jaringan
    • Mencadangkan Data
    • Memperbarui Apidog
    • Menghapus Akun
    • Fitur Eksperimental
  • Kirim request
    • Ikhtisar
    • Debugging SSE
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP atau WebService
    • GraphQL
    • gRPC
    • Gunakan Agen Proksi Permintaan untuk Debugging
    • Buat request
      • Riwayat Permintaan
      • Dasar-Dasar Permintaan
      • Parameter dan Body
      • Header Permintaan
      • Pengaturan Permintaan
      • Debug Permintaan
      • Menyimpan Permintaan sebagai Endpoint
      • HTTP/2
    • Autentikasi dan otorisasi
      • Ikhtisar
      • Sertifikat CA dan Klien
      • Jenis Otorisasi
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Autentikasi Hawk
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Respons dan cookie
      • Melihat Respons API
      • Mengelola Cookie
      • Ikhtisar
  • Mengembangkan dan men-debug API
    • Ikhtisar
    • Membuat Permintaan
    • Mengirim Permintaan
    • Kasus Debugging
    • Kasus Pengujian
    • Nilai Dinamis
    • Memvalidasi Respons
    • Design-First vs Request-First
    • Menghasilkan Kode
    • Environment dan variabel
      • Ikhtisar
      • Menggunakan Variabel
      • Manajemen Lingkungan
    • Rahasia vault
      • Gambaran Umum
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Modul nilai dinamis
      • Airline
      • Animal
      • Warna
      • Commerce
      • Perusahaan
      • Database
      • Tipe Data
      • Tanggal
      • Keuangan
      • Food
      • Git
      • Hacker
      • Helpers
      • Image
      • Internet
      • Lokasi
      • Lorem
      • Musik
      • Number
      • Orang
      • Telepon
      • Sains
      • String
      • System
      • Vehicle
      • Word
    • Pra dan pascaprosesor
      • Ikhtisar
      • Aservi
      • Ekstrak Variabel
      • Tunggu
      • Keamanan
      • Operasi basis data
        • Ikhtisar
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • Menggunakan skrip
        • Ikhtisar
        • Skrip Pra-Pemroses
        • Skrip Post-processor
        • Skrip Publik
        • Referensi Skrip Postman
        • Memanggil Bahasa Pemrograman Lain
        • Menggunakan Pustaka JS
        • Memvisualisasikan Respons
        • Contoh skrip
          • Skrip Aservi
          • Menggunakan Variabel
          • Memodifikasi Permintaan
          • Contoh Lainnya
    • Debugging API
      • AI Agent Debugger
      • A2A Debugger
  • Mendesain API
    • Ikhtisar
    • Membuat Proyek API Baru
    • Dasar-Dasar Endpoint
    • Panduan Desain API
    • Modul
    • Mengonfigurasi Beberapa Contoh Body Permintaan
    • Komponen
    • Field Umum
    • Parameter Global
    • Riwayat Perubahan Endpoint
    • Komentar
    • Manajemen Endpoint Batch
    • Custom Protocol API
    • Mode Spec-first (Beta)
    • Skema keamanan
      • Gambaran Umum
      • Membuat Skema Keamanan
      • Menggunakan Skema Keamanan
      • Skema Keamanan dalam Dokumentasi Online
    • Fitur lanjutan
      • Bidang Endpoint Kustom
      • Skenario Pengujian Terkait
      • Status Endpoint
      • Tampilan Daftar Parameter
      • Identifikasi Unik Endpoint
    • Schemas
      • Gambaran Umum
      • Membuat Schema Baru
      • Membangun Schema
      • Hasilkan Skema dari JSON dan Sebagainya
      • oneOf, allOf, anyOf
      • Menggunakan Discriminator
  • Pengujian API
    • Gambaran Umum
    • Skenario pengujian
      • Membuat Skenario Pengujian
      • Meneruskan Data Antar Permintaan
      • Kondisi Kontrol Alur
      • Sinkronisasi Data dari Endpoint dan Kasus Endpoint
      • Mengimpor Endpoint dan Kasus Endpoint dari Proyek Lain
      • Mengekspor Skenario Pengujian
    • Laporan pengujian
      • Laporan Pengujian
    • Jalankan skenario pengujian
      • Menjalankan Skenario Pengujian
      • Menjalankan Skenario Pengujian secara Batch
      • Pengujian Berbasis Data
      • Data Pengujian Bersama
      • Tugas Terjadwal
      • Mengelola Lingkungan Runtime API dari Proyek Lain
    • Suite pengujian
      • Ikhtisar
      • Membuat Rangkaian Pengujian
      • Mengorkestrasi Test Suite
      • Menjalankan Rangkaian Pengujian Secara Lokal
      • Menjalankan Suite Pengujian Melalui CLI
      • Tugas terjadwal
    • Uji API
      • Pengujian Integrasi
      • Pengujian Performa
      • Pengujian End-to-End
      • Pengujian Regresi
      • Pengujian Kontrak
    • Apidog CLI
      • Ikhtisar
      • Menginstal dan Menjalankan Apidog CLI
      • Opsi Apidog CLI
    • CI/CD
      • Ikhtisar
      • Integrate with Github Actions
      • Integrasikan dengan Gitlab
      • Integrate with Jenkins
      • Memicu Pengujian melalui Git Commit
  • Publikasikan dokumentasi API
    • Gambaran Umum
    • Teknologi API yang Didukung
    • Berbagi Cepat
    • Melihat Dokumentasi API
    • Dokumentasi Markdown
    • Menerbitkan Situs Dokumentasi
    • Halaman Login Kustom
    • Tata Letak Kustom
    • CSS, JavaScript, HTML Kustom
    • Domain Kustom
    • Fitur AI
    • Pengaturan SEO
    • Pengaturan lanjutan
      • Pencarian Dokumentasi
      • Proxy CORS
      • Mengintegrasikan Google Analytics
      • Pengaturan Pohon Folder
      • Pengaturan Visibilitas
      • Menyematkan Nilai dalam URL Dokumentasi
    • Versi API
      • Gambaran Umum
      • Membuat Versi API
      • Menerbitkan Versi API
      • Membagikan Endpoint dengan Versi API
  • Branch
    • Ikhtisar
    • Membuat Cabang Sprint
    • Menguji API dalam Branch
    • Merancang API dalam Cabang
    • Menggabungkan Cabang Sprint
    • Mengelola Cabang Sprint
    • AI Branch (Beta)
  • Fitur AI
    • Ikhtisar
    • Mengaktifkan Fitur AI
    • Membuat Kasus Pengujian
    • Memodifikasi Skema dengan AI
    • Pemeriksaan Kepatuhan Endpoint
    • Pemeriksaan Kelengkapan Dokumentasi API
    • Penamaan Field Berbasis AI
    • Tanya Jawab Umum
  • Server MCP Apidog
    • Ikhtisar
    • Hubungkan Proyek Apidog ke AI
    • Menghubungkan Dokumentasi yang Dipublikasikan ke AI
    • Menghubungkan File OpenAPI ke AI
  • Praktik terbaik
    • Menangani Tanda Tangan API
    • Mengakses API yang Dilindungi OAuth 2.0
    • Alur Kerja Kolaborasi
    • Mengelola Status Autentikasi
  • Ruang offline
    • Gambaran Umum
  • Administrasi
    • Mengelola proyek
      • Mengelola Proyek
      • Pengaturan Notifikasi
      • Mengelola Anggota Proyek
      • Resource proyek
        • Koneksi Database
        • Koneksi Git
    • Mengelola tim
      • Mengelola Tim
      • Mengelola Anggota Tim
      • Aktivitas Tim
      • Peran & Izin Tim
      • Resource tim
        • General Runner
        • Variabel Tim
        • Request Proxy Agent
      • Kolaborasi real-time
        • Kolaborasi Tim
    • Checklist onboarding
      • Konsep Dasar
      • Panduan Onboarding
    • Mengelola organisasi
      • Mengelola Organisasi
      • Peran & Izin Organisasi
      • Manajemen paket
        • Manajer Penagihan di Organisasi
      • Single Sign-On (SSO)
        • Ikhtisar SSO
        • Mengonfigurasi Microsoft Entra ID
        • Mengonfigurasi Okta
        • Mengonfigurasi SSO untuk Organisasi
        • Mengelola Akun Pengguna
        • Memetakan Grup ke Tim
      • Provisioning SCIM
        • Pengantar Provisioning SCIM
        • Microsoft Entra ID
        • Okta
      • Resource organisasi
        • Self-Hosted Runner
  • Apidog Europe
    • Apidog Europe
  • Penagihan
    • Ikhtisar
    • Kredit
    • Meningkatkan Paket Anda
    • Metode Pembayaran Alternatif
    • Mengelola Langganan
    • Memindahkan Tim Berbayar ke Organisasi
  • Add-on
    • API Hub
    • Plugin Apidog Intellij IDEA
    • Ekstensi browser
      • Chrome
      • Microsoft Edge
    • Proxy request
      • Proksi Permintaan di Web
      • Proxy Permintaan dalam Dokumen Bersama
      • Proxy Permintaan di Client
  • Data dan keamanan
    • Penyimpanan dan Keamanan Data
    • Privasi dan Keamanan Data Pengguna
    • Perutean Permintaan dan Keamanan Data
  • Referensi
    • Pendekatan API Design-First
    • Ekstensi Spesifikasi OpenAPI Apidog
    • JSONPath
    • XPath
    • Ekspresi Reguler
    • JSON Schema
    • Format File CSV
    • Menginstal Lingkungan Java
    • Lingkungan Deployment Runner
    • Sintaks Markdown Apidog
    • Ekstensi Swagger Apidog
      • Gambaran Umum
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Ekstensi JSON Schema Apidog
      • Ikhtisar
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • Pusat dukungan
    • Apidog Support Center
    • Impor/Ekspor
      • Bagaimana cara mengimpor data API ke Apidog?
      • Bagaimana cara mengimpor cURL di Apidog?
      • Bagaimana cara memigrasikan lingkungan Postman ke Apidog?
      • Bagaimana cara mengelompokkan endpoint secara otomatis saat impor Swagger/OpenAPI?
    • Mengirim request
      • Apakah Apidog mendukung Socket.IO?
      • Mengapa tanda "+" dalam nilai parameter didekodekan sebagai spasi?
      • Bagaimana cara mengirim permintaan di Apidog?
      • Bagaimana cara mengirim permintaan graphQL di Apidog?
      • Bagaimana cara mengirim permintaan gRPC di Apidog?
      • Bagaimana cara mengirim permintaan SOAP/WebService di Apidog?
      • Bagaimana cara mengirim permintaan WebSocket di Apidog?
      • Apakah Apidog mendukung skrip pra-permintaan/pengujian dan aservi dalam API WebSocket?
      • Bagaimana cara mengirim permintaan SSE di Apidog?
      • Bagaimana cara menambahkan header default pada tingkat folder?
      • Apakah Apidog mendukung skrip pra-permintaan/pengujian dan aservi dalam API gRPC?
      • Kesalahan Resolver DNS ELANREFUSED.DNS
      • Mengapa saya mendapatkan kesalahan "socket hang up" saat mengirim permintaan?
      • Memperbaiki error request
        • Memperbaiki Kesalahan read ECONNRESET
        • Memperbaiki Kesalahan ECONNREFUSED
        • Memperbaiki Kesalahan ETIMEDOUT
        • Memperbaiki Kesalahan ENOTFOUND: Couldn't resolve host
        • Memperbaiki Kesalahan ENOTFOUND: getaddrinfo ENOTFOUND www
        • Memperbaiki Kesalahan connect EHOSTUNREACH
    • Mendesain API
      • Bagaimana cara menggunakan variabel dalam path?
      • Dapatkah saya menggunakan komponen respons sebagai respons default?
      • Bagaimana cara memeriksa siapa yang telah memodifikasi endpoint?
      • Bagaimana cara menghapus folder endpoint secara massal di Apidog?
      • Bagaimana cara menambahkan/menghapus prefiks secara massal pada path endpoint?
      • Bagaimana cara memindahkan level Properti di Schema Editor?
      • Jika sebuah properti string memiliki beberapa nilai enumerasi dan digunakan di berbagai lokasi, bagaimana enum ini dapat dirujuk secara konsisten di seluruh bagian?
      • Bagaimana cara mendapatkan ID folder resource Apidog?
      • Bagaimana cara mendapatkan ID folder sumber daya Apidog?
      • Bagaimana cara menggunakan variabel dalam path URL?
      • Apa yang harus saya lakukan jika endpoint, dokumen, atau skenario pengujian tidak sengaja dihapus?
      • Apakah Apidog mendukung kode permintaan untuk endpoint kustom?
      • Bagaimana Cara Mengelompokkan Endpoint Secara Otomatis Saat Mengimpor Swagger/OpenAPI ke Apidog?
      • Bagaimana cara menghasilkan data array yang tidak duplikat dalam respons mock?
      • Mengapa input "#" tidak didukung di path?
    • Debugging API
      • Bagaimana Apidog berintegrasi dengan sistem manajemen kunci pihak ketiga?
      • Mengapa permintaan yang sama berfungsi dengan benar di alat lain (seperti Postman), tetapi tidak di Apidog?
      • Bagaimana cara mengambil nilai variabel dari database di Apidog?
      • Bagaimana memigrasikan lingkungan dari alat lain ke Apidog?
      • Bagaimana melakukan aservi menggunakan skrip di Apidog?
      • JSONPath hanya dapat mengekstrak array. Bagaimana kita dapat mengekstrak satu elemen dari dalam array tersebut di Apidog?
      • Bagaimana mengonfigurasi operasi database di Apidog ketika lingkungan yang berbeda memiliki kredensial akun database yang berbeda?
      • Bagaimana cara mendapatkan URL dasar layanan dalam skrip kustom?
      • Mengapa Apidog melaporkan kesalahan yang melebihi panjang string maksimum Node.js ketika respons API terlalu besar?
      • Berapa batas ukuran untuk pencetakan konsol? Mengapa saya mendapatkan kesalahan saat mencetak file berukuran besar?
      • Bagaimana cara mengatasi kesalahan koneksi database DB2 di Windows?
      • Mengapa Saya Mendapatkan Error NJS-045 Saat Menghubungkan ke Database Oracle di Apidog?
      • Bagaimana Cara Menghasilkan Nilai Dinamis dalam Skrip Kustom Apidog?
      • Mengapa permintaan klien untuk endpoint yang sama berhasil, tetapi terjadi kesalahan saat debugging di sisi web: "Tidak dapat meminta alamat"?
      • Mengapa Apidog melaporkan kesalahan ketika respons terlalu besar?
      • Bagaimana cara menggunakan endpoint perekaman Apidog?
      • Saat mendefinisikan respons endpoint, apakah endpoint diperbolehkan tidak memiliki konten respons?
      • Bagaimana cara mendapatkan baseURL layanan dalam skrip kustom?
      • Bagaimana cara melihat paket asli di Apidog?
      • Mengapa saya melihat galat "Invalid URI xxx" saat membuat permintaan?
      • Bagaimana cara membuat permintaan asinkron dalam skrip Apidog?
      • Mengapa saya melihat pesan "Couldn't resolve host" saat mengirim permintaan?
      • Berapa Batas Ukuran Cetak Konsol? Mengapa Saya Mendapatkan Error Saat Mencetak File Besar?
      • Bagaimana cara mengunggah file pada permintaan endpoint?
      • Apa yang Harus Dilakukan Jika Apidog Mengalami Crash atau Data Respons Tidak Ditampilkan?
      • URI Pengalihan Resmi yang Digunakan oleh Apidog untuk OAuth2.0
    • Data API mock
      • Bagaimana cara melakukan mock API secara otomatis?
      • Apa yang dapat dilakukan oleh mocking Apidog?
      • Bagaimana cara melakukan mock data API tetap di Apidog?
      • Bagaimana cara membuat mock data bersyarat di Apidog?
      • Bagaimana cara mengaktifkan cloud mock di Apidog?
      • Bagaimana cara mengaktifkan mock self-hosted di Apidog?
      • Apakah Apidog mendukung mocking API WebSocket?
      • Mengapa Browser Tidak Mengembalikan Konten Saat Meminta Mock endpoint?
    • Pengujian otomatis
      • Mengapa skenario pengujian berjalan tanpa masalah di klien lokal saya, tetapi terjadi kesalahan saat menjalankannya di Apidog CLI atau runner?
      • Bagaimana cara membuat skenario pengujian di Apidog?
      • Bagaimana cara meneruskan data antar langkah pengujian?
      • Mengapa saya tidak dapat berhasil mereferensikan data pra-langkah?
      • Bagaimana cara menggunakan foreach loop di Apidog?
      • Apa perbedaan antara sinkronisasi data dari endpoint/kasus endpoint?
      • Bagaimana cara menggunakan data pengujian di Apidog?
      • Bagaimana cara mengambil data pengujian dalam skrip di Apidog?
      • Bagaimana cara menjalankan skenario pengujian secara batch di Apidog?
      • Bagaimana cara menjadwalkan tugas pengujian di Apidog?
      • Bagaimana menjalankan pengujian performa di Apidog?
      • Bagaimana cara melihat permintaan dan respons aktual dalam pengujian performa?
      • Bagaimana cara mengekspor laporan pengujian kinerja di Apidog?
      • Bagaimana cara menggunakan hasil kueri database sebagai parameter untuk melakukan perulangan permintaan API?
      • Menangkap dan Memvalidasi Webhook Stripe di ApiDog Selama CI/CD
      • Bagaimana cara mengatasi kesalahan "Error: unable to verify the first certificate on runner"?
      • Kesalahan General Runner Docker Container "Not Found".
      • Bagaimana Cara Mengatur Host Server untuk General Runner di Versi Web Apidog?
      • Mengapa Skenario Pengujian Terjadwal Berakhir dengan 0 Permintaan?
      • Apa yang harus saya lakukan jika parameter unggahan file tidak dapat ditemukan di Runner atau CLI?
      • Bagaimana menggunakan Runner untuk menjalankan skenario pengujian dengan langkah unggah file?
      • Bagaimana cara mengatasi kesalahan "Error: unable to verify the first certificate on runner"?
      • Bagaimana cara mengakses dan mencari log runner untuk mengidentifikasi masalah ketika terjadi masalah pada runner?
      • Apa yang harus saya lakukan jika parameter endpoint berupa file unggahan dan tidak dapat ditemukan di Runner atau CLI?
      • Mengapa Langkah Pengujian Tidak Disinkronkan Secara Otomatis Saat Use Case API Berubah?
      • Mengapa Penggunaan Beberapa Tanda Dolar dalam Dokumen Markdown Menyebabkan Beberapa Konten Tidak Ditampilkan dengan Benar?
      • Apakah Runner yang di-host sendiri menghasilkan laporan pengujian di server setelah menjalankan tugas?
      • Dapatkah saya menambahkan pre/post processor terpadu ke permintaan dalam skenario pengujian?
      • Bagaimana cara menjaga nilai dinamis tetap konsisten selama satu kali proses pengujian otomatis?
    • Publikasikan dokumentasi API
      • Bagaimana cara menyembunyikan semua logo Apidog dalam dokumen yang dipublikasikan?
      • Ketika spesifikasi API diperbarui, apakah dokumentasi API akan berubah?
      • Bagaimana cara membagikan API kepada kolaborator di Apidog?
      • Bagaimana menyesuaikan domain dokumentasi Apidog?
      • Bagaimana cara membuat dokumentasi multi-versi di Apidog?
      • Cakupan berbagi untuk Publish Docs Sites di Apidog
      • Cakupan berbagi untuk daftar Share Doc di Apidog
      • Mengapa Share Docs yang Dipublikasikan Tidak Menampilkan Hostname?
      • Bagaimana Pengguna Dokumentasi Dapat Mengubah URL Dasar dalam Dokumentasi Bersama?
      • Dapatkah saya menduplikasi dokumen Apidog yang telah dipublikasikan untuk digunakan dalam proyek saya sendiri?
      • Cara Membagikan Header (misalnya, Token) di Dokumentasi Online Apidog?
      • Mengapa anggota tim saya tidak dapat menemukan dokumentasi yang telah dipublikasikan?
      • Bagaimana cara memperbaiki kedaluwarsa sertifikat SSL atau kesalahan Cloudflare 526 pada domain kustom saya?
      • SMTP Kustom Berhasil Dikonfigurasi, tetapi Pengguna dalam Daftar Izin Tidak Menerima Email OTP
    • Markdown
      • Bagaimana cara menggunakan kartu untuk menautkan ke berbagai halaman atau endpoint dalam Apidog?
      • Mengapa sebagian konten tidak ditampilkan dengan benar saat menggunakan beberapa simbol $ dalam dokumen Markdown?
      • Cara menggunakan gambar berlatar belakang transparan di Markdown Apidog?
      • Bagaimana cara mengatur lebar kolom tabel Markdown?
      • Bagaimana cara menyisipkan API internal, dokumen, skema data, atau folder ke dalam dokumen Markdown?
      • Bagaimana cara menambahkan tautan ke dokumen atau endpoint dalam sebuah proyek di komponen kartu Apidog?
    • Branch
      • Bagaimana cara mengakses sprint branch?
    • Administrasi
      • Bagaimana cara menginstal klien Apidog secara senyap?
      • Mengapa saya melihat kesalahan 'No Permission' meskipun memiliki akses admin?
      • Bagaimana cara memeriksa nomor versi runner?
      • Apakah Apidog mendukung win7?
      • Mengapa Apidog menampilkan kesalahan "Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll" setelah instalasi?
      • Perubahan Langganan dan Pengembalian Dana
      • Permintaan Web Berfungsi, Tetapi Aplikasi Mendapatkan "read ECONNRESET"—Mengapa?
      • Mengapa Saya Tidak Dapat Membuka Apidog Setelah Pembaruan Sistem Windows?
      • Mengapa Apidog gagal dibuka setelah pembaruan sistem Windows
    • Penagihan
      • Dapatkah saya menyiapkan akun penagihan terpisah untuk tim saya di Apidog?
      • Masalah Akses Tim & Penagihan di Apidog
      • Anggota tim yang diundang tidak dapat mengakses Apidog.
      • Mentransfer Tim Berbayar Personal ke Organisasi
    • On-premises
      • Manajemen Pengguna dan Akses di Apidog Self-Hosted Versi Enterprise
    • Web dan client
      • Pengunduhan dan Instalasi Versi Desktop Linux
  1. Apidog CLI

Opsi Apidog CLI

Apidog CLI digunakan untuk menjalankan pengujian otomatis dan mengelola sumber daya proyek Apidog dari terminal atau pipeline CI/CD. Apidog CLI mendukung eksekusi pengujian, pengelolaan sumber daya desain API, lingkungan dan variabel, impor dan ekspor, penerbitan dokumentasi, kolaborasi branch, serta administrasi proyek.

Sintaks Dasar Apidog CLI#

Sebagian besar perintah sumber daya proyek menggunakan --project <projectId> untuk menentukan proyek. Anda dapat menggunakan --branch <branchName> untuk beroperasi pada branch tertentu. Jika --branch dihilangkan, server menggunakan branch default.

Autentikasi#

Sebelum mengakses proyek privat, masuk atau berikan token akses.
PerintahDeskripsiContoh
loginMasuk dengan token akses dan menyimpannya secara lokal.apidog login --with-token <token>
logoutKeluar dan menghapus token lokal yang tersimpan.apidog logout
whoamiMenampilkan informasi tentang pengguna terautentikasi saat ini.apidog whoami
Anda juga dapat meneruskan token secara langsung saat menjalankan perintah:
Jika Anda menggunakan GitHub Actions, Anda dapat menyimpan token akses di Settings --> Secrets and Variables --> Actions --> Repository variables repositori Anda. Kemudian gunakan ${{ vars.APIDOG_ACCESS_TOKEN }} untuk merujuknya.

Skema CLI#

Gunakan cli-schema untuk memeriksa dan memvalidasi file JSON sebelum membuat atau memperbarui sumber daya kompleks. Hal ini membantu mengurangi kegagalan permintaan yang disebabkan oleh data yang tidak valid.
PerintahDeskripsiContoh
cli-schema listMencantumkan semua kunci skema yang didukung oleh CLI.apidog cli-schema list
cli-schema getMencetak JSON Schema untuk file data perintah.apidog cli-schema get endpoint-create
cli-schema validateMemvalidasi file JSON lokal terhadap kunci skema.apidog cli-schema validate endpoint-create --file ./endpoint.json
Kunci skema biasanya menggabungkan path perintah dan tindakan, seperti endpoint-create, test-scenario-update, dan merge-request-create.

Tim dan Proyek#

Perintah tim dan proyek merupakan titik awal untuk mengelola sumber daya melalui CLI. Gunakan perintah tersebut untuk menemukan ID yang diperlukan oleh perintah tingkat proyek.

Pengelolaan Tim#

PerintahDeskripsiContoh
team listMencantumkan tim yang dapat diakses oleh akun saat ini.apidog team list
team getMelihat detail tim tertentu.apidog team get <teamId>

Pengelolaan Proyek#

PerintahDeskripsiContoh
project listMencantumkan proyek yang dapat diakses oleh akun saat ini.apidog project list
project getMelihat detail proyek.apidog project get <projectId>
project createMembuat proyek di bawah sebuah tim.apidog project create --team <teamId> --name "New Project"

Pengaturan Proyek#

PerintahDeskripsiContoh
project settings getMelihat pengaturan tingkat proyek.apidog project settings get --project <projectId>
project settings updateMemperbarui pengaturan proyek dengan file JSON.apidog project settings update --project <projectId> --file ./project-settings.json
cli-schema get project-settings-updateMelihat skema untuk pembaruan pengaturan proyek.apidog cli-schema get project-settings-update

Lingkungan dan Variabel#

Gunakan perintah ini untuk mengelola lingkungan runtime, variabel global, dan variabel tim yang digunakan oleh debugging API dan pengujian otomatis.

Pengelolaan Lingkungan#

PerintahDeskripsiContoh
environment listMencantumkan lingkungan dalam sebuah proyek.apidog environment list --project <projectId>
environment getMelihat detail lingkungan, seperti URL dasar.apidog environment get <environmentId> --project <projectId>
environment createMembuat lingkungan.apidog environment create <name> --project <projectId> --base-url <url>
environment updateMemperbarui lingkungan.apidog environment update <environmentId> --project <projectId> --file ./environment.json
environment deleteMenghapus lingkungan.apidog environment delete <environmentId> --project <projectId>
cli-schema get environment-updateMelihat skema untuk pembaruan lingkungan.apidog cli-schema get environment-update

Pengelolaan Variabel#

PerintahDeskripsiContoh
variables listMencantumkan variabel berdasarkan cakupan.apidog variables list --project <projectId> --scope global
variables getMelihat nilai suatu variabel.apidog variables get --project <projectId> --scope global --key <key>
variables setMembuat atau memperbarui variabel.apidog variables set --project <projectId> --scope global --key <key> --value <value>
variables deleteMenghapus variabel.apidog variables delete --project <projectId> --scope global --key <key>
variables importMengimpor variabel dari file lokal.apidog variables import --project <projectId> --scope global --file ./variables.json
variables exportMengekspor variabel ke file lokal.apidog variables export --project <projectId> --scope global --output ./variables.json

Sumber Daya Desain API#

Gunakan perintah ini untuk mengelola sumber daya desain API, termasuk endpoint HTTP API, skema, folder, aturan mock, parameter umum, komponen respons, dan skema keamanan. Saat membuat atau memperbarui sumber daya kompleks, disarankan untuk menjalankan cli-schema get <schemaKey> dan cli-schema validate <schemaKey> --file <path> terlebih dahulu.

Endpoint HTTP API#

PerintahDeskripsiContoh
endpoint listMencantumkan endpoint HTTP API dalam sebuah proyek.apidog endpoint list --project <projectId>
endpoint getMelihat detail endpoint.apidog endpoint get <endpointId> --project <projectId>
endpoint createMembuat endpoint dari file JSON.apidog endpoint create --project <projectId> --file ./endpoint.json
endpoint updateMemperbarui endpoint.apidog endpoint update <endpointId> --project <projectId> --file ./endpoint.json
endpoint deleteMenghapus endpoint.apidog endpoint delete <endpointId> --project <projectId>
cli-schema get endpoint-createMelihat skema untuk pembuatan endpoint.apidog cli-schema get endpoint-create
cli-schema get endpoint-updateMelihat skema untuk pembaruan endpoint.apidog cli-schema get endpoint-update

Skema Data#

PerintahDeskripsiContoh
schema listMencantumkan skema data dalam sebuah proyek.apidog schema list --project <projectId>
schema getMelihat detail skema.apidog schema get <schemaId> --project <projectId>
schema createMembuat skema data dari file JSON.apidog schema create --project <projectId> --file ./schema.json
schema updateMemperbarui skema data.apidog schema update <schemaId> --project <projectId> --file ./schema.json
schema deleteMenghapus skema data.apidog schema delete <schemaId> --project <projectId>
cli-schema get schema-createMelihat skema untuk pembuatan skema data.apidog cli-schema get schema-create
cli-schema get schema-updateMelihat skema untuk pembaruan skema data.apidog cli-schema get schema-update

Dokumen Markdown#

PerintahDeskripsiContoh
doc listMencantumkan dokumen Markdown.apidog doc list --project <projectId>
doc getMelihat detail dokumen Markdown.apidog doc get <docId> --project <projectId>
doc createMembuat dokumen Markdown.apidog doc create --project <projectId> --file ./doc.json
doc updateMemperbarui dokumen Markdown.apidog doc update <docId> --project <projectId> --file ./doc.json
doc deleteMenghapus dokumen Markdown.apidog doc delete <docId> --project <projectId>

Folder Sumber Daya#

Gunakan perintah folder untuk mengelola pohon folder bagi berbagai jenis sumber daya. Opsi --type memilih jenis sumber daya, seperti endpoint, schema, test-scenario, response-component, security-scheme, test-suite, atau test-data.
PerintahDeskripsiContoh
folder listMencantumkan folder berdasarkan jenis sumber daya.apidog folder list --project <projectId> --type endpoint
folder createMembuat folder berdasarkan jenis sumber daya.apidog folder create --project <projectId> --type endpoint --name "New Folder"
folder moveMemindahkan folder ke folder induk lain.apidog folder move <folderId> --project <projectId> --type endpoint --parent <parentId>
folder updateMemperbarui nama, deskripsi, atau induk folder.apidog folder update <folderId> --project <projectId> --type endpoint --name "New Folder Name"
folder deleteMenghapus folder.apidog folder delete <folderId> --project <projectId> --type endpoint
cli-schema get folder-createMelihat skema untuk pembuatan folder.apidog cli-schema get folder-create
cli-schema get folder-updateMelihat skema untuk pembaruan folder.apidog cli-schema get folder-update
--type memilih jenis folder sumber daya. Opsi tersebut bukan nama folder. Kolom description hanya didukung untuk folder endpoint dan test-scenario; jenis folder lainnya hanya mendukung pembaruan nama dan induk.

Aturan Mock#

PerintahDeskripsiContoh
mock listMencantumkan aturan mock dalam proyek atau di bawah endpoint.apidog mock list --project <projectId> --http-api-id <endpointId>
mock getMelihat aturan mock.apidog mock get <mockId> --project <projectId>
mock createMembuat aturan mock dari file JSON.apidog mock create --project <projectId> --file ./mock.json
mock updateMemperbarui aturan mock.apidog mock update <mockId> --project <projectId> --file ./mock.json
mock deleteMenghapus aturan mock.apidog mock delete <mockId> --project <projectId>
cli-schema get mock-createMelihat skema untuk pembuatan aturan mock.apidog cli-schema get mock-create
cli-schema get mock-updateMelihat skema untuk pembaruan aturan mock.apidog cli-schema get mock-update

Parameter Umum#

PerintahDeskripsiContoh
common-parameter listMencantumkan parameter umum yang dapat digunakan kembali.apidog common-parameter list --project <projectId>
common-parameter getMelihat detail parameter umum.apidog common-parameter get <commonParameterId> --project <projectId>
common-parameter createMembuat parameter umum dari file JSON.apidog common-parameter create --project <projectId> --file ./common-parameter.json
common-parameter updateMemperbarui parameter umum.apidog common-parameter update <commonParameterId> --project <projectId> --file ./common-parameter.json
common-parameter importMengimpor parameter umum dari file.apidog common-parameter import --project <projectId> --file ./common-parameters.json
common-parameter exportMengekspor parameter umum ke file lokal.apidog common-parameter export --project <projectId> --output ./common-parameters.json

Komponen Respons#

PerintahDeskripsiContoh
response-component listMencantumkan komponen respons yang dapat digunakan kembali.apidog response-component list --project <projectId>
response-component getMelihat detail komponen respons.apidog response-component get <responseComponentId> --project <projectId>
response-component createMembuat komponen respons dari file JSON.apidog response-component create --project <projectId> --file ./response-component.json
response-component updateMemperbarui komponen respons.apidog response-component update <responseComponentId> --project <projectId> --file ./response-component.json
response-component deleteMenghapus komponen respons.apidog response-component delete <responseComponentId> --project <projectId>

Skema Keamanan#

PerintahDeskripsiContoh
security-scheme listMencantumkan skema keamanan dalam sebuah proyek.apidog security-scheme list --project <projectId>
security-scheme getMelihat detail skema keamanan.apidog security-scheme get <schemeId> --project <projectId>
security-scheme createMembuat skema keamanan dari file JSON.apidog security-scheme create --project <projectId> --file ./scheme.json
security-scheme updateMemperbarui skema keamanan.apidog security-scheme update <schemeId> --project <projectId> --file ./scheme.json
security-scheme deleteMenghapus skema keamanan.apidog security-scheme delete <schemeId> --project <projectId>
Path API adalah path sumber daya API, bukan path file lokal. Jika shell Anda menulis ulang nilai yang dimulai dengan /, bungkus path dengan tanda kutip, misalnya --path '/api/users', atau gunakan --file untuk menyediakan data endpoint.
Untuk kasus pengujian API atau langkah HTTP skenario pengujian, responseId harus menggunakan ID definisi respons endpoint dari endpoint.responses[].id, bukan ID komponen respons. Untuk menggunakan kembali komponen respons, tautkan terlebih dahulu dalam definisi respons endpoint.

Pengujian Otomatis#

Gunakan perintah ini untuk mengelola kasus pengujian API, skenario pengujian, rangkaian pengujian, data pengujian, laporan pengujian, runner, dan tugas terjadwal.

Kasus Pengujian API#

PerintahDeskripsiContoh
test-case listMencantumkan kasus pengujian API, secara opsional difilter berdasarkan endpoint.apidog test-case list --project <projectId> --endpoint <endpointId>
test-case categoryMencantumkan kategori kasus pengujian.apidog test-case category --project <projectId>
test-case getMelihat detail kasus pengujian API.apidog test-case get <caseId> --project <projectId>
test-case createMembuat kasus pengujian API dari file JSON.apidog test-case create --project <projectId> --file ./case.json
test-case updateMemperbarui kasus pengujian API.apidog test-case update <caseId> --project <projectId> --file ./case.json
test-case deleteMenghapus kasus pengujian API.apidog test-case delete <caseId> --project <projectId>
cli-schema get test-case-createMelihat skema untuk pembuatan kasus pengujian.apidog cli-schema get test-case-create
cli-schema get test-case-updateMelihat skema untuk pembaruan kasus pengujian.apidog cli-schema get test-case-update

Skenario Pengujian#

PerintahDeskripsiContoh
test-scenario listMencantumkan skenario pengujian dalam sebuah proyek.apidog test-scenario list --project <projectId>
test-scenario getMelihat detail skenario pengujian.apidog test-scenario get <scenarioId> --project <projectId>
test-scenario createMembuat skenario pengujian.apidog test-scenario create --project <projectId> --file ./scenario.json
test-scenario updateMemperbarui skenario pengujian.apidog test-scenario update <scenarioId> --project <projectId> --file ./scenario.json
test-scenario deleteMenghapus skenario pengujian.apidog test-scenario delete <scenarioId> --project <projectId>
test-scenario runMenjalankan skenario pengujian.apidog test-scenario run <scenarioId> --project <projectId> --environment <environmentId>
cli-schema get test-scenario-createMelihat skema untuk pembuatan skenario pengujian.apidog cli-schema get test-scenario-create
cli-schema get test-scenario-updateMelihat skema untuk pembaruan skenario pengujian.apidog cli-schema get test-scenario-update

Rangkaian Pengujian#

PerintahDeskripsiContoh
test-suite listMencantumkan rangkaian pengujian dalam sebuah proyek.apidog test-suite list --project <projectId>
test-suite getMelihat detail rangkaian pengujian.apidog test-suite get <testSuiteId> --project <projectId>
test-suite createMembuat rangkaian pengujian.apidog test-suite create --project <projectId> --file ./suite.json
test-suite updateMemperbarui rangkaian pengujian.apidog test-suite update <testSuiteId> --project <projectId> --file ./suite.json
test-suite deleteMenghapus rangkaian pengujian.apidog test-suite delete <testSuiteId> --project <projectId>
test-suite runMenjalankan rangkaian pengujian.apidog test-suite run <testSuiteId> --project <projectId> --environment <environmentId>

Data Pengujian#

PerintahDeskripsiContoh
test-data listMencantumkan set data pengujian.apidog test-data list --project <projectId>
test-data getMelihat detail set data pengujian.apidog test-data get <dataId> --project <projectId>
test-data createMembuat set data pengujian dari file JSON.apidog test-data create --project <projectId> --file ./test-data.json
test-data updateMemperbarui set data pengujian.apidog test-data update <dataId> --project <projectId> --file ./test-data.json
test-data deleteMenghapus set data pengujian.apidog test-data delete <dataId> --project <projectId>

Laporan Pengujian#

PerintahDeskripsiContoh
test-report listMencantumkan laporan pengujian dalam sebuah proyek.apidog test-report list --project <projectId>
test-report getMelihat detail laporan pengujian.apidog test-report get <reportId> --project <projectId>
test-report downloadMengunduh laporan pengujian ke file lokal.apidog test-report download <reportId> --project <projectId> --format json --output ./report.json
test-report deleteMenghapus laporan pengujian.apidog test-report delete <reportId> --project <projectId>

Runner#

PerintahDeskripsiContoh
runner listMencantumkan runner dalam proyek atau tim.apidog runner list --project <projectId>
runner getMelihat detail runner.apidog runner get <runnerId> --project <projectId>
runner createMembuat runner tim.apidog runner create --team <teamId> --name <name> --runner-type <runnerType> --server-type <serverType>
runner checkMemeriksa kesehatan runner.apidog runner check <runnerId> --team <teamId>
runner deleteMenghapus runner.apidog runner delete <runnerId> --project <projectId>

Tugas Terjadwal#

PerintahDeskripsiContoh
scheduled-task listMencantumkan tugas terjadwal dalam sebuah proyek.apidog scheduled-task list --project <projectId>
scheduled-task getMelihat detail tugas terjadwal.apidog scheduled-task get <taskId> --project <projectId>
scheduled-task createMembuat tugas terjadwal dari file JSON.apidog scheduled-task create --project <projectId> --file ./scheduled-task.json
scheduled-task updateMemperbarui tugas terjadwal.apidog scheduled-task update <taskId> --project <projectId> --file ./scheduled-task.json
scheduled-task deleteMenghapus tugas terjadwal.apidog scheduled-task delete <taskId> --project <projectId>
scheduled-task runMemicu tugas terjadwal secara manual.apidog scheduled-task run <taskId> --project <projectId>

Perintah Run Inti: apidog run#

Ini adalah perintah utama untuk menjalankan skenario pengujian, folder skenario pengujian, rangkaian pengujian, atau file lokal yang diekspor. Anda dapat menyalin perintah yang dihasilkan dari panel CI/CD klien Apidog dan menjalankannya di terminal atau alur kerja CI/CD Anda.

Eksekusi Online#

Saat menjalankan pengujian real-time melalui server Apidog, gunakan perintah berikut.
Gunakan token akses Apidog bersama dengan ID skenario pengujian tertentu, direktori skenario pengujian, atau rangkaian pengujian. Misalnya:

Eksekusi Lokal#

Saat menjalankan pengujian offline menggunakan file yang diekspor, gunakan perintah berikut.
Tentukan URL atau path file skenario pengujian Apidog. Misalnya:

Opsi Run#

OpsiDeskripsi
--access-token <accessToken>Menetapkan token autentikasi untuk eksekusi online
-t, --test-scenario <testScenarioId>Menentukan ID skenario pengujian yang akan dijalankan
-f, --test-scenario-folder <folderId>Menentukan ID direktori skenario pengujian yang akan dijalankan
--test-suite <testSuiteId>Menentukan ID rangkaian pengujian yang akan dijalankan
--project <projectId>Menentukan ID proyek
--branch <branchName>Menentukan nama branch; jika dihilangkan, server secara default menggunakan branch utama
-r, --reporters [reporters]Menentukan jenis laporan pengujian (default: ["cli"])
--out-dir <outDir>Direktori output untuk laporan pengujian (default: ./apidog-reports)
--out-file <outFile>Nama file laporan pengujian tanpa perlu menambahkan ekstensi file. Anda dapat menggunakan {FOLDER_NAME}, {SCENARIO_NAME}, dan {GENERATE_TIME}
--out-json-failures-separated <outJsonFailuresSeparated>Mengekspor kegagalan sebagai file JSON terpisah
-e, --environment <environmentId>Menentukan lingkungan runtime
-n, --iteration-count <n>Menetapkan jumlah iterasi
-d, --iteration-data <path>Menetapkan data untuk iterasi kasus (JSON atau CSV)
--on-error <behavior>Menetapkan perilaku penanganan kesalahan (ignore, continue, atau end)
--variables <path>Memuat variabel lingkungan atau global dari file lokal
--global-var <value>Menetapkan variabel global (format key=value)
--env-var <value>Menetapkan variabel lingkungan (format key=value)
--notification <ids>Mengirim notifikasi setelah proses run selesai
--notification-failed-event <ids>Mengirim notifikasi hanya saat proses run gagal
--external-program-path <path>Menentukan path file untuk program eksternal
--database-connection <path>Menentukan path file untuk konfigurasi basis data
--ignore-redirectsMencegah pengalihan otomatis
--silentMencegah output konsol
--color <value>Mengaktifkan atau menonaktifkan output konsol berwarna
--delay-request [n]Menentukan jeda antar permintaan (ms)
--timeout-request [n]Menentukan timeout permintaan (ms)
--timeout-script [n]Menentukan timeout eksekusi skrip (ms)
-k, --insecureMenonaktifkan verifikasi SSL
--ssl-client-cert-list <path>Menentukan path konfigurasi sertifikat klien
--ssl-client-cert <path>Menentukan path sertifikat klien (PEM)
--ssl-client-key <path>Menentukan path kunci privat sertifikat klien
--ssl-client-passphrase <passphrase>Menentukan passphrase sertifikat klien
--ssl-extra-ca-certs <path>Menentukan sertifikat CA tepercaya tambahan
-b, --bigintMengaktifkan kompatibilitas bigint
--upload-report [value]Mengunggah ringkasan laporan pengujian ke cloud
--preferred-http-version <preferredHttpVersion>Menetapkan versi protokol HTTP yang dipilih
--verboseMenampilkan informasi permintaan dan respons secara detail
--lang <language>Menetapkan bahasa CLI (en)
-h, --helpMenampilkan informasi bantuan
Saat membuat atau memperbarui sumber daya pengujian kompleks seperti skenario pengujian, rangkaian pengujian, kasus pengujian, data pengujian, atau tugas terjadwal, gunakan cli-schema get <schemaKey> terlebih dahulu, lalu validasi file lokal Anda dengan cli-schema validate <schemaKey> --file <path>.

Impor dan Ekspor#

Gunakan perintah impor dan ekspor untuk memasukkan dokumen API eksternal ke Apidog atau mengekspor data proyek ke format yang digunakan oleh alat lain.

Mengimpor Data Proyek#

Perintah import mengimpor file lokal ke dalam proyek. Format yang didukung mencakup openapi, postman, har, insomnia, jmeter, wsdl, yapi, rap2, apidoc, hoppscotch, markdown, jsonschema, dan apidog.
PerintahDeskripsiContoh
importMengimpor file lokal ke dalam proyek berdasarkan format.apidog import --project <projectId> --format openapi --file ./openapi.json

Pengaturan Impor Otomatis#

Gunakan import auto-import untuk memelihara pengaturan impor otomatis untuk sinkronisasi jangka panjang dari sumber eksternal.
PerintahDeskripsiContoh
import auto-import listMencantumkan pengaturan impor otomatis dalam sebuah proyek.apidog import auto-import list --project <projectId>
import auto-import createMembuat pengaturan impor otomatis.apidog import auto-import create --project <projectId> --file ./auto-import.json
import auto-import getMelihat pengaturan impor otomatis.apidog import auto-import get <settingId> --project <projectId>
import auto-import deleteMenghapus pengaturan impor otomatis.apidog import auto-import delete <settingId> --project <projectId>
cli-schema get import-auto-import-createMelihat skema untuk pengaturan impor otomatis.apidog cli-schema get import-auto-import-create

Mengekspor Data Proyek#

Perintah export mengekspor data proyek ke file lokal. Format yang didukung mencakup openapi, markdown, html, postman, dan apidog.
Untuk ekspor native apidog, cakupan mendukung all, apis, dan tags. Cakupan folder hanya tersedia untuk ekspor OpenAPI.
PerintahDeskripsiContoh
exportMengekspor data proyek berdasarkan format.apidog export --project <projectId> --format openapi --output ./openapi.json
export --format apidogMengekspor data proyek native.apidog export --project <projectId> --format apidog --output ./project.apidog.json
export --scope apisMengekspor API terpilih dalam format native.apidog export --project <projectId> --format apidog --scope apis --api-ids 1001,1002 --output ./selected.apidog.json
export --scope tagsMengekspor API berdasarkan tag dalam format native.apidog export --project <projectId> --format apidog --scope tags --include-tags pet,store --output ./tagged.apidog.json
export --format openapi --scope foldersMengekspor folder terpilih dalam format OpenAPI.apidog export --project <projectId> --format openapi --scope folders --folder-ids 2001 --output ./openapi.json

Pengaturan Ekspor OAS#

Gunakan export settings untuk memelihara pengaturan ekspor OAS yang dapat digunakan kembali.
PerintahDeskripsiContoh
export settings listMencantumkan pengaturan ekspor OAS.apidog export settings list --project <projectId>
export settings createMembuat pengaturan ekspor OAS.apidog export settings create --project <projectId> --file ./export-setting.json
export settings getMelihat pengaturan ekspor OAS.apidog export settings get <settingId> --project <projectId>
export settings updateMemperbarui pengaturan ekspor OAS.apidog export settings update <settingId> --project <projectId> --file ./export-setting.json
export settings deleteMenghapus pengaturan ekspor OAS.apidog export settings delete <settingId> --project <projectId>
cli-schema get export-settings-createMelihat skema untuk pembuatan pengaturan ekspor OAS.apidog cli-schema get export-settings-create
cli-schema get export-settings-updateMelihat skema untuk pembaruan pengaturan ekspor OAS.apidog cli-schema get export-settings-update

Berbagi Dokumentasi#

Gunakan perintah ini untuk menerbitkan dan membagikan dokumentasi API.

Situs Dokumentasi#

PerintahDeskripsiContoh
docs-site listMencantumkan situs dokumentasi.apidog docs-site list --project <projectId>
docs-site getMelihat detail situs dokumentasi.apidog docs-site get <siteId> --project <projectId>
docs-site createMembuat situs dokumentasi.apidog docs-site create --project <projectId> --file ./docs-site.json
docs-site updateMemperbarui pengaturan situs dokumentasi.apidog docs-site update <siteId> --project <projectId> --file ./docs-site.json
docs-site deleteMenghapus situs dokumentasi.apidog docs-site delete <siteId> --project <projectId>

Dokumen Bersama#

PerintahDeskripsiContoh
shared-doc listMencantumkan dokumen bersama.apidog shared-doc list --project <projectId>
shared-doc getMelihat detail dokumen bersama.apidog shared-doc get <docId> --project <projectId>
shared-doc createMembuat dokumen bersama.apidog shared-doc create --project <projectId> --file ./shared-doc.json
shared-doc updateMemperbarui pengaturan dokumen bersama.apidog shared-doc update <docId> --project <projectId> --file ./shared-doc.json
shared-doc deleteMenghapus dokumen bersama.apidog shared-doc delete <docId> --project <projectId>

Pengelolaan Branch#

Gunakan perintah branch untuk mengisolasi perubahan, berkolaborasi pada sumber daya proyek, dan menggabungkan sumber daya terpilih antar-branch.

Branch Iterasi#

PerintahDeskripsiContoh
branch list --type allMencantumkan semua jenis branch dalam sebuah proyek.apidog branch list --project <projectId> --type all
branch list --type sprintMencantumkan branch iterasi.apidog branch list --project <projectId> --type sprint
branch get --type sprintMelihat branch iterasi.apidog branch get <branchName> --project <projectId> --type sprint
branch create --type sprintMembuat branch iterasi.apidog branch create --project <projectId> --type sprint --name <branchName> --from main
branch update --type sprintMemperbarui branch iterasi.apidog branch update <branchName> --project <projectId> --type sprint --name <newName>
branch mergeMenggabungkan sumber daya yang dipilih secara eksplisit dari satu branch ke branch lain.apidog branch merge --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids>
branch pick-toMemilih sumber daya terpilih dari branch sumber ke branch target.apidog branch pick-to --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids>
branch archive --type sprintMengarsipkan branch iterasi sebelum penghapusan.apidog branch archive <branchName> --project <projectId> --type sprint
branch delete --type sprintMenghapus branch iterasi yang telah diarsipkan.apidog branch delete <branchName> --project <projectId> --type sprint

Branch AI#

PerintahDeskripsiContoh
branch list --type aiMencantumkan branch AI.apidog branch list --project <projectId> --type ai
branch get --type aiMelihat branch AI.apidog branch get <branchName> --project <projectId> --type ai
branch create --type aiMembuat branch AI dari branch sumber.apidog branch create --project <projectId> --type ai --name <aiBranchName> --from <sourceBranchName>
branch update --type aiMemperbarui branch AI.apidog branch update <branchName> --project <projectId> --type ai --name <newName>
branch archive --type aiMengarsipkan branch AI sebelum penghapusan.apidog branch archive <branchName> --project <projectId> --type ai
branch delete --type aiMenghapus branch AI yang telah diarsipkan.apidog branch delete <branchName> --project <projectId> --type ai

Branch Umum#

PerintahDeskripsiContoh
branch list --type generalMencantumkan branch umum.apidog branch list --project <projectId> --type general
branch get --type generalMelihat branch umum.apidog branch get <branchName> --project <projectId> --type general
branch create --type generalMembuat branch umum.apidog branch create --project <projectId> --type general --name <branchName> --from main
branch update --type generalMemperbarui branch umum.apidog branch update <branchName> --project <projectId> --type general --name <newName>
branch delete --type generalMenghapus branch umum.apidog branch delete <branchName> --project <projectId> --type general
Perintah pembuatan branch terutama menggunakan opsi baris perintah seperti --type, --name, dan --from. cli-schema get branch-*-create digunakan untuk memeriksa struktur opsi pembuatan. Untuk opsi perintah yang sebenarnya, jalankan apidog branch create -h.

Merge Request#

Gunakan merge-request saat branch target memerlukan alur peninjauan. Merge request dan penggabungan langsung hanya menggabungkan sumber daya yang dipilih secara eksplisit.
PerintahDeskripsiContoh
merge-request previewMemindai perubahan kandidat sebelum membuat merge request atau penggabungan langsung.apidog merge-request preview --project <projectId> --from <sourceBranchName> --to <targetBranchName>
merge-request listMencantumkan merge request.apidog merge-request list --project <projectId> --to <targetBranchName>
merge-request getMelihat detail merge request.apidog merge-request get <mergeRequestId> --project <projectId> --to <targetBranchName>
merge-request createMembuat merge request.apidog merge-request create --project <projectId> --to <targetBranchName> --from <sourceBranchName> --reviewer-ids <userIds> --endpoint-ids <ids>
merge-request updateMemperbarui merge request.apidog merge-request update <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./merge-request.json
merge-request approveMenyetujui merge request.apidog merge-request approve <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./approve.json
merge-request rejectMenolak merge request.apidog merge-request reject <mergeRequestId> --project <projectId> --to <targetBranchName>
merge-request deleteMenghapus merge request.apidog merge-request delete <mergeRequestId> --project <projectId> --to <targetBranchName>
Untuk menjaga keamanan sumber daya proyek, izin tulis CLI mungkin dibatasi secara default. Anda dapat mengedit data branch sumber melalui branch AI, atau mengaktifkan izin pengeditan eksternal dalam pengaturan fitur proyek saat pengeditan langsung diperlukan untuk branch utama, branch iterasi standar, atau branch umum. Perubahan yang dibuat pada branch AI tetap memerlukan konfirmasi pengguna sebelum merge atau merge-request.
Nama branch AI disarankan menyertakan tanggal, branch sumber, dan tujuan, misalnya ai/20260312-from-main-user-register.
Untuk operasi merge dan pick pada branch, opsi ID sumber daya menggunakan nama jamak dan ID numerik yang dipisahkan koma, seperti --endpoint-ids 1,2, --doc-ids 3,4, dan --test-suite-ids 5,6.

Sumber Daya Lainnya#

Gunakan perintah ini untuk mengelola sumber daya ekstensi proyek dan koneksi eksternal.

Kolom Kustom#

PerintahDeskripsiContoh
custom-field listMencantumkan kolom kustom.apidog custom-field list --project <projectId>
custom-field createMembuat kolom kustom.apidog custom-field create --project <projectId> --file ./custom-field.json
custom-field updateMemperbarui kolom kustom.apidog custom-field update <customFieldId> --project <projectId> --file ./custom-field.json
custom-field deleteMenghapus kolom kustom.apidog custom-field delete <customFieldId> --project <projectId>

API WebSocket#

PerintahDeskripsiContoh
websocket listMencantumkan API WebSocket.apidog websocket list --project <projectId>
websocket getMelihat detail API WebSocket.apidog websocket get <websocketId> --project <projectId>
websocket createMembuat API WebSocket.apidog websocket create --project <projectId> --name <name> --url <url>
websocket updateMemperbarui API WebSocket.apidog websocket update <websocketId> --project <projectId> --file ./websocket.json
websocket deleteMenghapus API WebSocket.apidog websocket delete <websocketId> --project <projectId>

API Socket.IO#

PerintahDeskripsiContoh
socketio listMencantumkan API Socket.IO.apidog socketio list --project <projectId>
socketio getMelihat detail API Socket.IO.apidog socketio get <socketioId> --project <projectId>
socketio createMembuat API Socket.IO.apidog socketio create --project <projectId> --file ./socketio.json
socketio updateMemperbarui API Socket.IO.apidog socketio update <socketioId> --project <projectId> --file ./socketio.json
socketio deleteMenghapus API Socket.IO.apidog socketio delete <socketioId> --project <projectId>

Skrip Umum#

PerintahDeskripsiContoh
common-script listMencantumkan skrip umum.apidog common-script list --project <projectId>
common-script getMelihat detail skrip umum.apidog common-script get <scriptId> --project <projectId>
common-script createMembuat skrip umum.apidog common-script create --project <projectId> --file ./common-script.json
common-script updateMemperbarui skrip umum.apidog common-script update <scriptId> --project <projectId> --file ./common-script.json
common-script deleteMenghapus skrip umum.apidog common-script delete <scriptId> --project <projectId>

Koneksi Basis Data#

PerintahDeskripsiContoh
database-connection listMencantumkan koneksi basis data.apidog database-connection list --project <projectId>
database-connection getMelihat detail koneksi basis data.apidog database-connection get <connectionId> --project <projectId>
database-connection createMembuat koneksi basis data.apidog database-connection create --project <projectId> --file ./database-connection.json
database-connection updateMemperbarui koneksi basis data.apidog database-connection update <connectionId> --project <projectId> --file ./database-connection.json
database-connection deleteMenghapus koneksi basis data.apidog database-connection delete <connectionId> --project <projectId>

Penyedia Vault#

PerintahDeskripsiContoh
vault listMencantumkan penyedia vault.apidog vault list --project <projectId>
vault getMelihat detail penyedia vault.apidog vault get <vaultProviderId> --project <projectId>
vault createMembuat penyedia vault.apidog vault create --project <projectId> --file ./vault.json
vault updateMemperbarui penyedia vault.apidog vault update <vaultProviderId> --project <projectId> --file ./vault.json
vault deleteMenghapus penyedia vault.apidog vault delete <vaultProviderId> --project <projectId>

Koneksi Git#

PerintahDeskripsiContoh
git-connection listMencantumkan koneksi Git.apidog git-connection list --project <projectId>
git-connection getMelihat detail koneksi Git.apidog git-connection get <connectionId> --project <projectId>
git-connection createMembuat koneksi Git.apidog git-connection create --project <projectId> --file ./git-connection.json
git-connection updateMemperbarui koneksi Git.apidog git-connection update <connectionId> --project <projectId> --file ./git-connection.json
git-connection deleteMenghapus koneksi Git.apidog git-connection delete <connectionId> --project <projectId>

Manajemen dan Pengaturan#

Gunakan perintah ini untuk administrasi proyek, notifikasi, sumber daya recycle bin, riwayat perubahan, dan log audit.

Notifikasi#

PerintahDeskripsiContoh
notification listMencantumkan konfigurasi notifikasi.apidog notification list --project <projectId>
notification getMelihat detail notifikasi.apidog notification get <notificationId> --project <projectId>
notification createMembuat konfigurasi notifikasi.apidog notification create --project <projectId> --file ./notification.json
notification updateMemperbarui konfigurasi notifikasi.apidog notification update <notificationId> --project <projectId> --file ./notification.json
notification deleteMenghapus konfigurasi notifikasi.apidog notification delete <notificationId> --project <projectId>

Recycle Bin#

PerintahDeskripsiContoh
recycle listMencantumkan sumber daya dalam recycle bin.apidog recycle list --project <projectId>
recycle restoreMemulihkan sumber daya dari recycle bin.apidog recycle restore <itemId> --project <projectId>
recycle deleteMenghapus sumber daya recycle bin secara permanen.apidog recycle delete <itemId> --project <projectId>

Riwayat#

PerintahDeskripsiContoh
history listMencantumkan riwayat perubahan proyek.apidog history list --project <projectId>
history getMelihat detail riwayat perubahan.apidog history get <historyId> --project <projectId>

Log Audit#

PerintahDeskripsiContoh
audit-log listMencantumkan log audit proyek.apidog audit-log list --project <projectId>
audit-log getMelihat detail log audit.apidog audit-log get <auditLogId> --project <projectId>

Penggunaan Lanjutan#

Mengunggah File di CLI#

Saat bekerja dengan API yang memerlukan unggahan file, menetapkan path file yang akan diunggah secara akurat sangat penting. Anda harus menyimpan file pada mesin yang sama tempat pengujian berjalan dan merujuknya menggunakan path absolut atau relatif. Ikuti langkah-langkah berikut untuk merujuk file yang akan diunggah.
1
Salin file yang diperlukan ke mesin yang menjalankan CLI terlebih dahulu. Misalnya, jika Anda menggunakan GitHub Actions sebagai pipeline CI/CD Anda, salin file yang diperlukan ke repositori GitHub yang sama dengan workflow Anda.
2
Di Apidog, buka skenario pengujian Anda dan temukan langkah yang memerlukan unggahan file. Klik tombol Bulk Edit seperti ditunjukkan di bawah ini.
Tombol Edit Batch dalam detail langkah skenario pengujian
3
Salin path file yang telah Anda salin ke mesin CLI. Kemudian ganti nilai parameter kolom file dengan path file pada mesin CLI. Misalnya, jika Anda meletakkan file png di bawah folder data dalam repo GitHub, Anda dapat menggunakan data/to-be-uploaded.png untuk merujuknya.
Konfigurasi path file dalam mode edit batch
Setelah konfigurasi ini, file dapat dikirim dengan benar ke Apidog melalui CLI.
Jika Anda ingin menjalankan skenario pengujian ini secara lokal lagi, Anda perlu mengubah path file dalam nilai parameter kembali ke path pada mesin lokal Anda.

Menggunakan Operasi Basis Data di CLI#

Saat skenario pengujian Anda mencakup operasi basis data, Anda perlu melakukan beberapa langkah tambahan karena konfigurasi basis data disimpan secara lokal, bukan di cloud. Ini berarti Anda tidak dapat langsung menjalankan CLI dalam mode cloud untuk skenario tersebut. Berikut cara menangani situasi ini:
1
Untuk skenario pengujian yang mencakup operasi basis data, Anda akan melihat prompt pada antarmuka pembuatan baris perintah: "Download the database configuration file."
2
Unduh file ini dan letakkan di direktori tempat Anda berencana menjalankan Apidog CLI.
3
Baris perintah yang dibuat secara otomatis akan menyertakan opsi --database-connection. Anda dapat menggunakan baris perintah ini apa adanya untuk menjalankan pengujian Anda.

Mengunggah Laporan Pengujian CLI Lokal ke Cloud#

Untuk mengunggah laporan pengujian CLI lokal Anda ke cloud, Anda dapat menambahkan parameter --upload-report di akhir perintah CLI Anda. Berikut cara melakukannya:
1
Tambahkan parameter --upload-report ke perintah CLI Anda:
2
Perintah ini akan menjalankan pengujian Anda dan secara otomatis mengunggah laporan pengujian ke cloud setelah selesai.
3
Untuk melihat laporan yang diunggah:
Buka bagian "Test Reports" di dashboard Apidog Anda.
Cari kolom "Team Reports".
4
Catatan: Untuk laporan yang diunggah melalui CLI, kolom "Tester" akan ditampilkan kosong.

Menggunakan Skrip/Program Eksternal di CLI#

Anda dapat merujuk skrip atau program eksternal saat menjalankan Apidog CLI dengan menambahkan path-nya di akhir perintah. Berikut cara melakukannya:
Dalam contoh ini, CLI diinstruksikan untuk merujuk program yang berada di direktori ./scripts. Jika tidak ada hierarki yang ditentukan, default-nya adalah direktori eksekusi CLI saat ini.
Ada dua pendekatan utama untuk mengelola skrip eksternal ini:

1. Path Lokal#

Untuk menghindari kebingungan dalam mengelola skrip lokal, disarankan untuk:
Mengorganisasi semua file skrip berdasarkan kategori
Menempatkannya dalam direktori tertentu
Menentukan path lokal yang sesuai dalam perintah CLI

2. Repositori Kode Cloud#

Sebagai alternatif, Anda dapat:
Meng-host file skrip dalam repositori kode berbasis cloud
Menyiapkan perintah pull dalam workflow CI/CD Anda untuk mengambil skrip eksternal ke lingkungan lokal
Menentukan path aktual skrip eksternal dalam perintah CLI

SSL#

Sertifikat Klien#

Apidog CLI mendukung penerusan sertifikat klien.

Menggunakan Satu Sertifikat Klien SSL#

--ssl-client-cert
Menentukan path sertifikat klien SSL publik.
--ssl-client-key
Menentukan path sertifikat klien SSL privat (opsional).
--ssl-client-passphrase
Menentukan passphrase klien SSL (opsional).

Menggunakan File Konfigurasi Sertifikat Klien SSL (Mendukung Beberapa Sertifikat)#

--ssl-client-cert-list
Menentukan path file JSON daftar sertifikat klien SSL. Misalnya: ssl-client-cert-list.json
[
    {
        "name": "domain1",
        "matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
        "key": {"src": "/CI/client.domain1.key"},
        "cert": {"src": "/CI/client.domain1.crt"},
        "passphrase": "changeme"
    },
    {
        "name": "domain2",
        "matches": ["https://domain2.com/*"],
        "key": {"src": "/CI/client.domain2.key"},
        "cert": {"src": "/CI/client.domain2.crt"},
        "passphrase": "changeme"
    }
]
Opsi ini mendukung penetapan sertifikat klien SSL yang berbeda berdasarkan URL atau hostname. Opsi ini memiliki prioritas atas opsi --ssl-client-cert, --ssl-client-key, dan --ssl-client-passphrase. Opsi-opsi tersebut akan digunakan sebagai opsi fallback jika tidak ada kecocokan untuk URL dalam daftar.

HTTP/2#

CLI dapat dikonfigurasi untuk menggunakan versi protokol tertentu saat mengirim permintaan dengan menggunakan parameter --preferred-http-version.
Nilai parameter versi protokol:
1.
"HTTP/2" - HTTP/2 Application-Layer Protocol Negotiation (ALPN), hanya didukung untuk permintaan HTTPS.
2.
"HTTP/2-with-prior-knowledge" - HTTP/2 dengan prior knowledge.
3.
"HTTP/1" - HTTP/1.1.
Parameter tersebut mendukung konfigurasi berikut:
1.
Menetapkan versi protokol yang berbeda untuk permintaan HTTPS dan HTTP:
2.
Menetapkan versi protokol yang sama untuk HTTPS dan HTTP:
3.
Menetapkan HTTP/2 untuk HTTPS dan HTTP (nilai yang tidak didukung akan diabaikan secara otomatis):

FAQ#

Bagaimana menangani pesan kesalahan Invalid character in header content['Authorization']?
Kesalahan ini biasanya disebabkan oleh karakter yang tidak valid dalam header Authorization, seperti karakter non-ASCII, pemutusan baris, atau spasi tambahan. Jika Anda yakin bahwa menjalankan skenario pengujian di klien Apidog atau antarmuka web tidak menghasilkan kesalahan apa pun, periksa apakah Anda telah menetapkan nilai INITIAL untuk variabel dalam lingkungan Anda dan pastikan bahwa nilai Authorization sesuai dengan format yang diharapkan.
Bagaimana saya dapat mengedit data proyek secara langsung tanpa menggunakan branch AI?
Izin tulis proyek mungkin dibatasi demi keamanan. Periksa pengaturan fitur proyek dan aktifkan izin pengeditan eksternal saat pengeditan langsung diperlukan.
Modified at 2026-06-11 10:17:04
Previous
Menginstal dan Menjalankan Apidog CLI
Next
Ikhtisar
Built with