Modul API Apidog memiliki dua mode yang dapat dialihkan di sudut kiri bawah antarmuka: Mode Design-first dan Mode Request-first.Kedua mode menyediakan fungsionalitas yang serupa tetapi dengan antarmuka yang berbeda, untuk mengakomodasi alur kerja tim yang berbeda.Mode Design-first adalah mode yang direkomendasikan Apidog, cocok untuk tim yang mengikuti pendekatan API-Design First. Dalam mode ini, tim menentukan spesifikasi API terlebih dahulu, lalu melanjutkan pengembangan dan pengujian berdasarkan spesifikasi API tersebut.Di sisi lain, Mode Request-first ideal untuk tim yang tidak mendefinisikan spesifikasi API sejak awal. Tim seperti ini biasanya berfokus pada pengembangan backend, menyelesaikan kode, lalu menghasilkan spesifikasi API agar pengujian dan pekerjaan sisi klien dapat dimulai.Jika Anda perlu memanggil API yang dikembangkan oleh orang lain tetapi tidak memiliki dokumentasinya, Anda juga sebaiknya menggunakan Mode Request-first.
Mode Design-First#
Dalam Mode Design-first, pengeditan spesifikasi API dan pengiriman permintaan diakses melalui tab terpisah. Pengguna mengubah spesifikasi API di tab Edit dan mengirim permintaan di tab Run.Pemisahan ini sesuai untuk tim yang mengikuti pendekatan API-Design First, di mana arsitek API dan pengembang/konsumen memiliki peran yang berbeda. Arsitek API mendefinisikan spesifikasi API tanpa mengirim permintaan, sementara pengembang berfokus pada pengembangan dan pengujian API tanpa mengubah spesifikasi API.Tab yang dipisahkan tersebut selaras dengan kebiasaan penggunaan tim seperti ini. Di tab Edit, arsitek API dapat menentukan contoh permintaan, yang secara otomatis ditetapkan sebagai nilai parameter default di tab Run. Pengembang/konsumen API dapat mengubah lebih lanjut nilai parameter dan body permintaan di tab Run.Mode Request-First#
Mode Request-first cocok untuk tim yang tidak menentukan API terlebih dahulu. Pengembang backend bekerja langsung pada pengembangan API dan mungkin perlu memanggil API untuk debugging selama pengembangan.Dalam mode ini, pengembang tidak perlu menentukan API pada awalnya; sebagai gantinya, mereka dapat memasukkan permintaan secara langsung, mirip dengan membuat permintaan baru di Postman. Dalam antarmuka ini, pengembang dapat dengan mudah mengubah jenis parameter, nama, nilai, komponen body, dan lainnya tanpa perlu menyesuaikan spesifikasi API dan nilai parameter permintaan secara terpisah.Setelah debugging selesai dan disimpan, permintaan secara otomatis diuraikan menjadi spesifikasi endpoint. Parameter diterjemahkan menjadi parameter spesifikasi dan nilai contoh, sementara body permintaan/respons diuraikan menjadi skema, dan nilai body ditafsirkan sebagai contoh permintaan/respons. Pengembang dapat lebih lanjut menyempurnakan dan meningkatkan spesifikasi endpoint ini berdasarkan kebutuhan mereka.Perbedaan Antarmode#
Perbedaan utama antara kedua mode adalah bahwa dalam Mode Request-first, body permintaan digunakan sebagai contoh body permintaan endpoint. Sebaliknya, dalam Mode Design-first, pengguna dapat memasukkan body permintaan aktual di tab Run bersama dengan contoh body permintaan. Oleh karena itu, bagian body di tab Run HANYA tersedia dalam Mode Design-first dan tidak terlihat dalam Mode Request-first.Perbedaan lainnya adalah bahwa dalam Mode Design-first, Anda dapat menambahkan pre/post-processor pada tingkat spesifikasi endpoint atau pada tingkat run/kasus endpoint. Sedangkan, dalam Mode Request-first, karena tidak ada tab Run, semua pre/post-processor dianggap berada pada tingkat spesifikasi endpoint. Pre/post-processor tingkat run/kasus endpoint tidak terlihat dalam Mode Request-first. 