Saat bekerja dengan API, penting untuk memahami cara mengirim berbagai jenis data bersama permintaan Anda. Apidog menyediakan antarmuka yang ramah pengguna untuk membantu Anda menyusun dan mengirim permintaan API dengan berbagai parameter dan tipe data body.Parameter#
Parameter memungkinkan Anda mengirim informasi tambahan ke server. Apidog mendukung dua jenis utama parameter: Query params dan Path params.Query Params#
Parameter query ditambahkan ke akhir URL setelah tanda tanya (?) dan dipisahkan dengan ampersand (&). Parameter ini digunakan untuk mengirim data opsional atau tambahan ke server.Di Apidog, Anda memiliki dua cara praktis untuk menambahkan parameter query ke permintaan API Anda:1.
Langsung di URL: Anda dapat menambahkan parameter query langsung ke akhir URL di bilah alamat. Contoh:https://api.example.com/users?page=1&limit=10
2.
Menggunakan bagian Query Params: Apidog menyediakan bagian Query Params khusus di bawah bidang input URL. Di sini, Anda dapat menambahkan, mengedit, dan menghapus parameter query menggunakan antarmuka yang ramah pengguna. Parameter yang Anda tambahkan di bagian ini akan secara otomatis ditambahkan ke URL permintaan.
Tanda Sama Dengan dalam Query Params#
Dalam beberapa kasus khusus, parameter query mungkin tidak muncul sebagai pasangan kunci-nilai. Misalnya, URL permintaan mungkin berupa:https://api.example.com/users?available
available dapat berfungsi sebagai parameter dengan nilai kosong. Ketika nilainya kosong, Apidog secara otomatis menghilangkan tanda sama dengan antara kunci dan nilai.Jika Anda tidak ingin menghilangkan tanda sama dengan ini, Anda dapat mengubahnya secara manual menjadi "Add an equal sign".Path Params#
Parameter path adalah bagian dari path URL itu sendiri dan biasanya digunakan untuk mengidentifikasi sumber daya tertentu. Parameter ini ditandai dengan placeholder dalam URL, biasanya diapit oleh kurung kurawal {}.https://api.example.com/users/{userId}
{param} akan diganti dengan nilai sebenarnya. Fitur ini sangat berguna saat menguji API RESTful yang menggunakan pengidentifikasi sumber daya dalam URL.Jika Anda perlu menggunakan variabel dalam parameter path, cara yang disarankan adalah pertama-tama menggunakan {param} dalam URL, lalu menggunakan {{variable}} pada nilai param.
Body#
Body permintaan digunakan untuk mengirim data ke server sebagai bagian dari permintaan POST, PUT, atau PATCH. Apidog mendukung berbagai format data body untuk mengakomodasi kebutuhan API yang berbeda.Perbandingan Tipe Body#
Tabel berikut memberikan perbandingan singkat dari tipe body yang tersedia:| Tipe Body | Content-Type | Kasus Penggunaan | Dukungan Unggah File |
|---|
| form-data | multipart/form-data | Pengiriman formulir dengan file | ✓ Ya |
| x-www-form-urlencoded | application/x-www-form-urlencoded | Pengiriman formulir sederhana | ✗ Tidak |
| JSON | application/json | Pertukaran data terstruktur | ✗ Tidak |
| XML | application/xml | Sistem lama, API SOAP | ✗ Tidak |
| raw | Kustom (text/plain, dll.) | Format data kustom | ✗ Tidak |
| binary | application/octet-stream | Unggahan file, data biner | ✓ Ya |
| GraphQL | application/json | Query/mutation GraphQL | ✗ Tidak |
| msgpack | application/msgpack | Transfer data berkinerja tinggi | ✗ Tidak |
Form-data adalah cara untuk mengirim pasangan kunci-nilai, mirip dengan mengirim formulir HTML. Format ini sangat berguna ketika Anda perlu mengunggah file bersama data lain.Body bertipe form-data akan ditampilkan sebagai multipart/form-data dalam permintaan. Untuk setiap parameter dalam body, Anda dapat memilih tipenya, seperti string, integer, dan sebagainya.Mengirim JSON dalam form-data: Jika Anda perlu mengirim JSON dalam form-data, Anda perlu menetapkan tipe parameter ke string, lalu mengisi JSON di bidang string.Mengirim file: Jika Anda perlu mengirim file dalam permintaan, pilih tipe sebagai file, lalu klik "Upload" untuk memilih file lokal.Apidog hanya mengirim file dalam permintaan tetapi tidak menyimpan file tersebut di cloud. Oleh karena itu, selama kolaborasi tim, orang lain dapat melihat permintaan ini tetapi tidak dapat langsung mengirim file ini. Anda perlu mentransfer file ini kepada rekan kerja Anda melalui cara lain agar mereka dapat mengirimnya.
JSON#
JSON adalah format data yang banyak digunakan untuk permintaan dan respons API. Anda dapat merancang skema data di bagian Request → Body → JSON pada sebuah endpoint.Saat merancang skema data JSON, Anda dapat menggunakan fitur Generate from JSON di Apidog untuk membuat skema dengan cepat alih-alih menambahkan setiap bidang secara manual.Saat menambahkan bidang secara manual, tipe data default adalah string. Jika Anda perlu menambahkan bidang bersarang, ubah tipe bidang menjadi object atau array.Jika Anda ingin menambahkan komentar dalam JSON, Anda dapat mengaktifkan "JSON with comments support" di Settings → General settings → Feature settings → Advanced settings. Saat mengirim JSON, komentar ini akan secara otomatis dihapus.
XML#
XML (eXtensible Markup Language) adalah format data umum lainnya yang digunakan dalam komunikasi API. Apidog mendukung payload XML, memungkinkan Anda mengirim data terstruktur dalam format XML bersama permintaan API Anda.raw#
Opsi raw memungkinkan Anda mengirim format data kustom apa pun dalam body permintaan. Ini berguna saat bekerja dengan API yang mengharapkan struktur atau format data tertentu yang tidak tercakup oleh opsi lainnya.binary#
Data biner dapat dikirim menggunakan opsi ini, yang sangat berguna saat mengunggah file atau bekerja dengan API yang mengharapkan payload biner. Apidog memungkinkan Anda memilih dan mengirim file biner sebagai bagian dari permintaan API Anda.GraphQL#
Untuk API yang menggunakan GraphQL, Apidog menyediakan editor GraphQL khusus. Fitur ini memungkinkan Anda menyusun dan mengirim query serta mutation GraphQL, lengkap dengan penyorotan sintaks dan pelengkapan otomatis.Lihat dokumentasi GraphQL di Apidog untuk informasi lebih lanjut tentang bekerja dengan API GraphQL.
msgpack#
MessagePack (msgpack) adalah format serialisasi biner yang lebih ringkas dan lebih cepat daripada JSON. Apidog mendukung pengiriman data msgpack, yang bermanfaat saat bekerja dengan API yang dioptimalkan untuk kinerja dan transfer data yang lebih rendah. 