RESTful API (Representational State Transfer) telah menjadi standar de-facto untuk komunikasi klien-server dalam Pengembangan Web. RESTful API yang dirancang dengan baik memiliki struktur URL dan desain endpoint yang logis dan konsisten. Prinsip-prinsip struktur URL RESTful dan endpoint: Di dalam artikel ini, Anda akan dapat membaca tentang praktik terbaik untuk struktur URL dan endpoint RESTful.
Apa yang dimaksud dengan URL RESTful?
URL istirahat pada dasarnya adalah alamat web sumber daya dalam API istirahat. RESTful API terikat oleh prinsip-prinsip tertentu untuk membuat URL menjadi ringkas, terdefinisi, dan menunjukkan tindakan yang mereka lakukan. Di aplikasi web lain, URL mungkin berubah-ubah, tetapi URL istirahat dibuat sedemikian rupa sehingga dapat menunjukkan sumber daya mana yang dikembalikan.
Sebagai contoh:
- URL dasar: https://api.example.com/
- URL Pengangkatan: https://api.example.com/users
Di sini /users adalah kumpulan sumber daya individual untuk pengguna, kesederhanaan dan kejelasan struktur ini memudahkan pengembang untuk memahami dan menggunakan API.
Prinsip Utama Desain URL RESTful
1. Struktur Berbasis Sumber Daya: RESTful API berorientasi pada bisnis. Dalam RESTful API, setiap URL adalah sumber daya yang unik (Pengguna, Produk, Pesanan) Sumber daya biasanya merupakan kata benda jamak untuk menunjukkan koleksi:
- /products untuk daftar produk
- /products/{id} untuk produk tertentu.
2. Metode dan Tindakan HTTP: API RESTful menggunakan metode HTTP yang umum sebagai tindakan pada sumber daya. Pendekatan ini sesuai dengan operasi CRUD (Buat, Baca, Perbarui, Hapus):
- GET untuk mengambil sumber daya.
- POST untuk membuat sumber daya baru
- PUT atau PATCH untuk memperbarui sumber daya.
- DELETE untuk menghapus beberapa sumber daya.
Contoh:
- Permintaan GET /users mendapatkan semuanya.
- Membuat pengguna baru POST /users
- GET /users/123 mengembalikan pengguna dengan id 123.
- DELETE /users/123 menghapus pengguna dengan id 123.
3. Hubungan Hirarkis: Jika Anda memiliki sumber daya terkait, struktur URL harus mencerminkan hierarki tersebut. Sebagai contoh:
- /users/123/orders mengambil pesanan untuk pengguna 123.
- /users/123/orders/456 dapat digunakan untuk mendapatkan pesanan 456 untuk pengguna 123.
Struktur ini memudahkan untuk memahami bagaimana sumber daya yang berbeda berhubungan satu sama lain dalam grafik.
4. Tanpa kewarganegaraan: RESTful API tidak memiliki kewarganegaraan, yaitu setiap permintaan berisi semua data yang diperlukan untuk diproses. URL tidak bergantung pada sesi/konteks sisi server. Sebagai contoh:
- Hindari: /pesanan-kini
- Lebih suka: /pengguna/{userId}/pesanan/{pesananId}
5. Direkomendasikan Gunakan Parameter Kueri: Untuk Menyaring dan Mengurutkan Parameter kueri berguna untuk menambahkan lebih banyak batasan tanpa membuat jalur sumber daya menjadi eksplisit. Sebagai contoh:
- /produk? kategori=elektronik
- /produk? sort=harga&urutan=desc
6. Kata kerja dalam URL: Desain RESTful didasarkan pada sumber daya, bukan tindakan. Gunakan metode HTTP daripada menyertakan kata kerja dalam URL:
- Hindari: /buat-pengguna
- Lebih suka: POST /pengguna
Praktik Terbaik untuk Titik Akhir RESTful
1. Memastikan Konsistensi: Ikuti konvensi dan format penamaan yang seragam di seluruh endpoint. Hal ini membantu pengembang untuk dengan mudah memprediksi dan mempelajari API.
2. Pembuatan versi: Ketika API berubah dan berkembang, penggunaan versi API membantu menghindari perubahan pada klien yang sudah ada. Gunakan URL atau tajuk untuk nomor versi:
3. Penanganan Kesalahan: Menangani kesalahan dengan baik dan memberikan umpan balik yang berguna. Mengembalikan kode HTTP sehingga kami tahu apakah berhasil atau gagal: 200 OK atau 404 tidak ditemukan atau 400 Permintaan buruk
4. Dokumentasi: Endpoint harus didokumentasikan dengan baik, yang merupakan faktor penting dalam kegunaan. Meliputi informasi tambahan tentang parameter, respons, dan contoh.
5. Keamanan: Amankan semua komunikasi API klien dengan HTTPS. Otentikasi dan otorisasi seperti kunci API atau OAuth
Kesimpulan
Jika mendesain URL dan titik akhir RESTful itu mudah, semua orang akan melakukannya. Dengan bantuan prinsip-prinsip yang berorientasi pada sumber daya, penggunaan metode HTTP yang umum, dan fokus pada konsistensi, para pengembang dapat membuat API yang intuitif, dapat diperluas, dan nyaman digunakan. Struktur URL yang baik dan desain titik akhir berkontribusi pada pengalaman pengguna, integrasi{” ”}
Jadi, apakah Anda sedang membangun API sederhana atau sistem yang lebih rumit, menginvestasikan waktu untuk desain yang matang di awal akan membayar dividen dalam hal pemeliharaan dan kepuasan dengan pengalaman pengembang.
