Ikhtisar

Panduan ini akan membantu Anda memulai dengan cepat, mulai dari menyiapkan akun hingga membuat permintaan API pertama Anda.

Panduan Video

Lihat daftar putar lengkap Getting Started with Apidog di YouTube.

Prasyarat

Sebelum memulai, pastikan Anda telah memiliki:

Penyiapan Akun: Daftar untuk akun Apidog gratis di app.apidog.com jika Anda belum memilikinya.

Masuk: Masuk ke aplikasi web Apidog atau aplikasi klien (Unduh Di Sini).

Buka Proyek: Mulai proyek baru atau impor proyek yang sudah ada untuk mengatur API Anda. Pelajari selengkapnya tentang proyek dan konsep dasar atau panduan UI Apidog.

Proyek Pet Store

Proyek Pet Store adalah contoh bawaan Apidog yang membantu Anda mempelajari konsep dan fitur utama. Mulailah dengan mengeklik Create Sample Project pada halaman sambutan Apidog.

Pilih Model Pengembangan Anda

Apidog mendukung dua pendekatan utama pengembangan API:

Model	Deskripsi	Paling Sesuai Untuk	Alur Kerja
Design-first	Menentukan spesifikasi API sebelum implementasi	Tim yang memprioritaskan perencanaan dan dokumentasi	Spec → Request → Test → Share
Request-first	Membangun dan menguji API dari permintaan aktual	Tim agile, pembuatan prototipe, API tanpa dokumentasi	Request → Spec → Test → Share

Kedua model didukung sepenuhnya dan dapat dialihkan kapan saja. Pilih berdasarkan preferensi alur kerja tim Anda. Pelajari selengkapnya tentang Mode Design-first & Mode Request-first.

Model Design-first

Dalam pendekatan Design-first, Anda menentukan spesifikasi API sejak awal, memastikan kejelasan dan konsistensi sebelum implementasi. Metode ini ideal untuk tim yang memprioritaskan perencanaan dan ingin membuat dokumentasi komprehensif sejak awal.

Tentukan endpoint baru
Tentukan endpoint API Anda dengan path, method, parameter, dan respons. Ini menciptakan fondasi spesifikasi API Anda.

Beralih ke mode Design-first
Di sudut kiri bawah antarmuka Apidog, pilih mode "Design-first" untuk melanjutkan perancangan endpoint Anda.

Buat permintaan ke endpoint
Uji endpoint yang telah Anda tentukan dengan mengirim permintaan aktual untuk memvalidasi desain.

Tambahkan aservi
Siapkan pemeriksaan otomatis untuk memastikan respons API Anda memenuhi kriteria yang diharapkan.

Buat skenario pengujian
Bangun rangkaian pengujian komprehensif yang mencakup beberapa endpoint dan kasus penggunaan.

Bagikan dokumentasi API Anda
Publikasikan dan bagikan dokumentasi API Anda kepada pemangku kepentingan untuk mendapatkan umpan balik dan integrasi.

Jelajahi fitur lanjutan
Pelajari lebih dalam kemampuan Apidog seperti lingkungan, schema, dan alat kolaborasi.

Mulai dengan Design-first

Tentukan endpoint pertama Anda

Model Request-first

Pendekatan Request-first dimulai dengan panggilan API aktual, sehingga Anda dapat membuat prototipe dan memvalidasi API dengan cepat. Metode ini sangat sesuai untuk tim yang bekerja dengan backend yang sudah ada, API pihak ketiga, atau ketika Anda perlu mendokumentasikan endpoint yang belum terdokumentasi.

Kirim permintaan
Lakukan panggilan API untuk menguji atau menjelajahi endpoint yang sudah ada.

Beralih ke mode Request-first
Di sudut kiri bawah antarmuka Apidog, pilih mode "Request-first".

Tambahkan aservi
Terapkan aturan validasi otomatis untuk memastikan keandalan dan ketepatan API.

Buat skenario pengujian
Kembangkan rangkaian pengujian komprehensif yang mensimulasikan interaksi API dunia nyata.

Bagikan dokumentasi API Anda
Buat dan distribusikan dokumentasi API profesional untuk tim dan mitra Anda.

Jelajahi fitur lanjutan
Temukan seluruh rangkaian alat pengujian, kolaborasi, dan otomatisasi Apidog.

Mulai dengan Request-first

Kirim permintaan pertama Anda

Beralih Antar Mode

Anda dapat beralih antara mode Design-first dan Request-first kapan saja menggunakan toggle di sudut kiri bawah antarmuka:

Fleksibilitas ini memungkinkan Anda menyesuaikan alur kerja seiring berkembangnya proyek Anda.

Panduan Video#

Prasyarat#

Pilih Model Pengembangan Anda#

Model Design-first#

Model Request-first#

Beralih Antar Mode#

Panduan Video

Prasyarat

Pilih Model Pengembangan Anda

Model Design-first

Model Request-first

Beralih Antar Mode