Dalam postingan blog ini, kita akan membahas semua yang perlu Anda ketahui tentang API dan permintaan PUT. Kita akan mulai dengan menjelaskan apa itu API, kemudian kita akan membahas apa itu permintaan PUT dan bagaimana perbedaannya dari metode HTTP lainnya seperti POST.
Kami akan memberi Anda beberapa praktik terbaik dan format respons umum untuk API, dan menunjukkan cara membuat permintaan PUT di Apidog.
Jelajahi Apidog dengan mengunduhnya secara gratis dan mulai pengujian sekarang!
Jadi, tanpa basa-basi lagi, mari selami dunia API dan permintaan PUT!
Apa itu API?
API, atau Application Programming Interface, adalah serangkaian aturan yang ditentukan yang memungkinkan aplikasi yang berbeda untuk berkomunikasi satu sama lain. Ini seperti pelayan yang mengambil pesanan Anda dan menyampaikannya ke dapur dan kemudian mengembalikan makanan Anda kepada Anda. API membantu komponen perangkat lunak yang berbeda untuk berkomunikasi dan mentransfer data dengan mudah dan aman. Mereka seperti saus rahasia yang membuat pengembangan dan inovasi perangkat lunak lebih sederhana dan lebih efisien.
Misalnya, ketika Anda menggunakan aplikasi seluler untuk memesan tumpangan, aplikasi tersebut menggunakan API untuk berkomunikasi dengan server layanan transportasi online untuk mendapatkan lokasi pengemudi, ETA, dan detail lainnya. Ini membantu aplikasi untuk menampilkan informasi kepada Anda secara real time.
Singkatnya, API seperti perekat yang menyatukan komponen perangkat lunak yang berbeda, memungkinkan mereka untuk bekerja dengan lancar dan efisien.
Apa itu Permintaan PUT?
Permintaan PUT adalah metode permintaan HTTP yang digunakan untuk memperbarui atau mengganti sumber daya yang ada di server. Permintaan PUT membuat sumber daya baru atau mengganti representasi sumber daya target dengan payload permintaan.
Permintaan memiliki body dan respons yang berhasil memiliki body. Permintaan PUT tidak aman dan bersifat idempotent. Tidak diizinkan dalam formulir HTML. Berikut adalah contoh permintaan PUT:
PUT /new.html HTTP/1.1
Host: example.com
Content-type: text/html
Content-length: 16
<p>New File</p>
Jika sumber daya target tidak memiliki representasi saat ini dan permintaan PUT berhasil membuatnya, maka server asal harus memberi tahu agen pengguna dengan mengirimkan respons 201 (Created). Jika sumber daya target memiliki representasi saat ini dan representasi tersebut berhasil dimodifikasi sesuai dengan keadaan representasi terlampir, maka server asal harus mengirimkan respons 200 (OK) atau 204 (No Content) untuk menunjukkan keberhasilan penyelesaian permintaan.
Bagaimana Cara Kerja Permintaan PUT?
Ketika Anda membuat permintaan HTTP PUT, dan Request-URI mengarah ke sumber daya yang ada, server sepenuhnya mengganti sumber daya tersebut dengan data yang terlampir dalam body permintaan PUT. Jika Request-URI tidak mengarah ke sumber daya yang ada, server dapat membuat sumber daya dengan URL tersebut.
Permintaan PUT vs POST
Perbedaan antara permintaan PUT dan permintaan POST adalah bahwa permintaan PUT bersifat idempotent, yang berarti bahwa memanggilnya sekali atau beberapa kali berturut-turut memiliki efek yang sama (yaitu tidak ada efek samping), sedangkan permintaan POST identik berturut-turut mungkin memiliki efek tambahan, mirip dengan melakukan pemesanan beberapa kali. Permintaan PUT digunakan untuk memperbarui atau mengganti sumber daya yang ada di server, sedangkan permintaan POST digunakan untuk menambahkan sumber daya di server.
Cara Mengirim Permintaan PUT di API
Untuk mengirim permintaan PUT di API, Anda perlu menentukan metode HTTP sebagai PUT dan URL sumber daya yang ingin Anda perbarui atau ganti. Anda juga perlu menyertakan representasi sumber daya yang diperbarui dalam payload permintaan. Berikut adalah contoh permintaan PUT di Python menggunakan pustaka requests:
import requests
url = 'https://example.com/api/resource/1'
data = {'key': 'value'}
response = requests.put(url, json=data)
Dalam contoh ini, metode requests.put() mengirimkan permintaan PUT ke URL yang ditentukan dengan representasi sumber daya yang diperbarui dalam parameter data. Respons dari server disimpan dalam variabel response.
Membuat dan Menguji Permintaan PUT di Apidog
Apidog adalah platform kolaborasi terintegrasi untuk dokumentasi API, debugging API, mocking API, dan pengujian otomatis API yang menggabungkan Postman, Swagger, Mock, dan JMeter untuk mengatasi masalah sinkronisasi data antara sistem yang berbeda menggunakan serangkaian sistem dan serangkaian data.
Ini adalah platform kolaborasi API all-in-one yang menyediakan dokumentasi API, debugging API, mocking API, dan pengujian otomatis API. Dengan sistem tunggal dan data terpusat, Apidog memecahkan masalah sinkronisasi data di berbagai sistem. Setelah dokumen API ditentukan, debugging API, mocking data, dan pengujian API dapat langsung digunakan tanpa perlu didefinisikan ulang.
Untuk membuat dan menguji permintaan PUT di Apidog, Anda dapat mengikuti langkah-langkah berikut:
- Buka Apidog: Buka Apidog dan buat permintaan baru.
2. Tentukan metode HTTP: Pilih PUT sebagai metode HTTP.
3. Tentukan URL permintaan: Masukkan URL sumber daya yang ingin Anda perbarui, tambahkan header permintaan, dan/atau body permintaan. Kemudian klik tombol "Kirim" untuk mengirim permintaan PUT
4. Periksa respons: Periksa respons dari server untuk memastikan bahwa permintaan PUT berhasil.
Praktik Terbaik untuk Menggunakan Permintaan PUT di API
Berikut adalah beberapa praktik terbaik untuk menggunakan permintaan PUT di API:
- Gunakan format respons yang konsisten: Sebaiknya gunakan format respons yang konsisten untuk semua endpoint Anda, termasuk permintaan PUT. Ini dapat memudahkan klien untuk memahami dan bekerja dengan API Anda.
- Pastikan bahwa pembaruan bersifat idempotent: Operasi idempotent adalah operasi yang dapat diulang beberapa kali tanpa menyebabkan efek yang tidak diinginkan. Permintaan PUT bersifat idempotent, yang berarti bahwa memanggilnya sekali atau beberapa kali berturut-turut memiliki efek yang sama. Ini karena payload permintaan berisi representasi sumber daya yang diperbarui. Jika sumber daya tidak ada, sumber daya baru dibuat dengan representasi yang ditentukan.
- Atur desain API di sekitar sumber daya: API REST dirancang di sekitar sumber daya, yang merupakan segala jenis objek, data, atau layanan yang dapat diakses oleh klien. Sumber daya memiliki pengidentifikasi, yang merupakan URI yang secara unik mengidentifikasi sumber daya tersebut. Misalnya, URI untuk pesanan pelanggan tertentu mungkin:
https://example.com/orders/1. - Tentukan operasi API dalam hal metode HTTP: API REST menggunakan metode HTTP standar untuk melakukan operasi pada sumber daya. Operasi yang paling umum adalah GET, POST, PUT, PATCH, dan DELETE. Permintaan PUT digunakan untuk memperbarui atau mengganti sumber daya yang ada di server, sedangkan permintaan POST digunakan untuk menambahkan sumber daya di server.
- Sesuai dengan semantik HTTP: API REST harus sesuai dengan semantik HTTP. Misalnya, permintaan PUT harus digunakan untuk memperbarui atau mengganti sumber daya yang ada, sedangkan permintaan POST harus digunakan untuk menambahkan sumber daya di server. Ini membantu memastikan bahwa API Anda konsisten dan mudah digunakan.
Beberapa format respons umum dari Permintaan PUT
Format respons untuk permintaan PUT tergantung pada desain API dan kasus penggunaan tertentu. Namun, merupakan praktik yang baik untuk menggunakan format respons yang konsisten untuk semua endpoint Anda, termasuk permintaan PUT. Berikut adalah beberapa format respons umum untuk permintaan PUT:
- Kode status HTTP 200 OK: Kode status ini dikembalikan untuk PUT yang berhasil dari pembaruan ke sumber daya yang ada. Tidak diperlukan body respons. Kode status HTTP 204 No Content bahkan lebih tepat.
- Kode status HTTP 201 Created: Kode status ini dikembalikan untuk PUT yang berhasil dari sumber daya baru, dengan URI yang paling spesifik untuk sumber daya baru yang dikembalikan di bidang header Lokasi dan URI dan metadata sumber daya relevan lainnya yang digaungkan di body respons.
- Kode status HTTP 409 Conflict: Kode status ini dikembalikan untuk PUT yang tidak berhasil karena modifikasi pihak ketiga, dengan daftar perbedaan antara pembaruan yang dicoba dan sumber daya saat ini di body respons.
- Kode status HTTP 400 Bad Request: Kode status ini dikembalikan untuk PUT yang tidak berhasil, dengan teks bahasa alami (seperti bahasa Inggris) di body respons yang menjelaskan mengapa PUT gagal.
Kesimpulan
Dalam postingan blog ini, kita belajar tentang PUT, metode HTTP yang digunakan untuk membuat atau memperbarui sumber daya di server. Ini digunakan untuk memperbarui catatan yang ada, dan jika catatan tidak ada, itu membuat yang baru. Perbedaan mendasar antara permintaan POST dan PUT tercermin dalam arti yang berbeda dari Request-URI.
Saat mendesain API, penting untuk menggunakan metode yang tepat tergantung pada objek apa yang Anda referensikan dalam permintaan. Jika Anda memberi nama objek URL yang Anda buat secara eksplisit, maka gunakan PUT.
Selain itu, kita belajar cara membuat dan menguji API menggunakan Apidog API Developing Toolkit. Toolkit ini memungkinkan Anda untuk mendesain dan mengembangkan API lebih cepat dan bersama-sama. 🚀
