Klien Apidog mendukung pengiriman permintaan API dengan HTTP, GraphQL, SOAP, gRPC, dan protokol populer lainnya. Anda dapat membuat permintaan di Apidog, mengirimkannya untuk mengamati respons, dan menyimpannya untuk kolaborasi tim.Membuat Permintaan Baru#
Untuk membuat permintaan di Apidog, Anda hanya perlu mengeklik "+" → "Permintaan Baru".Anda dapat mengisi bagian-bagian permintaan yang diperlukan sesuai dengan spesifikasi API ke dalam antarmuka Apidog, seperti metode permintaan, URL, parameter permintaan, otorisasi, dan sebagainya.Dengan menggunakan metode ini, Anda dapat membuat permintaan HTTP, GraphQL, dan SOAP. Pelajari lebih lanjut tentang pembuatan permintaan WebSocket dan gRPC dalam dokumentasi protokol masing-masing.URL Permintaan#
Untuk membuat permintaan di Apidog, Anda perlu menentukan URL yang mewakili endpoint API yang Anda hubungkan. Setiap operasi yang dapat Anda lakukan menggunakan API biasanya dikaitkan dengan sebuah endpoint, yang memiliki URL tertentu.Jika Anda sedang membangun API: URL biasanya terdiri dari lokasi dasar ditambah path. Misalnya, dalam URL permintaan https://api.example.com/user/12, https://api.example.com adalah URL dasar, dan /user/12 adalah path endpoint.
Jika Anda menggunakan API publik: Penyedia API Anda akan menyediakan URL yang Anda perlukan dalam dokumentasi pengembang mereka.
Anda dapat memasukkan parameter kueri di bidang URL, atau Anda dapat memasukkannya di tab Params. Jika permintaan Anda menggunakan parameter path, Anda dapat memasukkannya di bidang URL.Apidog akan secara otomatis menambahkan http:// ke awal URL Anda jika Anda tidak menentukan protokol.
Metode Permintaan#
Di Apidog, Anda dapat memilih metode permintaan yang akan digunakan di sisi kiri URL permintaan. Metode default adalah GET.Metode HTTP Umum#
| Metode | Tujuan | Dampak pada Data |
|---|
| GET | Mengambil data dari sumber daya tertentu | Hanya baca, tanpa efek samping |
| POST | Mengirimkan data untuk diproses ke sumber daya tertentu | Membuat sumber daya baru |
| PUT | Memperbarui sumber daya yang sudah ada | Mengganti seluruh sumber daya |
| PATCH | Menerapkan modifikasi sebagian pada sumber daya | Memperbarui bidang tertentu |
| DELETE | Meminta penghapusan sumber daya | Menghapus sumber daya |
Dalam desain API, URL yang sama dapat diminta dengan metode yang berbeda, yang mewakili operasi berbeda pada sumber daya yang sama. Misalnya, GET /user/{id} biasanya mengambil informasi pengguna untuk id ini, sedangkan PUT /user/{id} memperbarui informasi pengguna untuk id ini.Mengirim Permintaan#
Setelah Anda menentukan protokol, metode, dan URL permintaan, tambahkan detail lain yang diperlukan oleh API tujuan pengiriman permintaan Anda:Parameter dan Body: Sediakan parameter, data body, atau header permintaan apa pun yang perlu dikirim bersama permintaan.
Autentikasi: Siapkan autentikasi dan otorisasi apa pun yang diperlukan.
Cookies: Anda juga memiliki opsi untuk menggunakan cookies dengan permintaan Anda dengan memilih tab Cookies.
Setelah Anda memasukkan semua detail permintaan, pilih Send untuk mengirimkan permintaan ke server API. Anda dapat melihat respons dari server di panel respons.Anda dapat melihat permintaan yang telah Anda kirim di History pada bilah sisi dan mengirimkannya kembali. Ini berguna untuk debugging dan membandingkan respons dari waktu ke waktu.