URL Design

    Ketika membangun REST API, elemen penting yang harus diperhatikan adalah URL, Path, atau Endpoint. Merancang endpoint yang baik akan membuat API lebih mudah dipahami. Agar penggunaan API kami sesuai dengan standar yang diharapkan banyak developer, saat merancang endpoint, Anda harus mengikuti aturan umum atau konvensi. Lalu, seperti apa standar dalam merancang endpoint? 

source image: https://goviralwebdesign.com/

Gunakan Kata Benda daripada Kata Kerja pada Endpoint Path

    Dalam menentukan nama endpoint (titik akhir path), hindari menggunakan kata kerja. Untuk ilustrasi, gunakan /getArticles atau /addArticles. Karena aksi dapat ditentukan dengan mudah melalui HTTP Verb, kita tidak perlu menambahkan kata kerja lagi ke endpoint. Dengan HTTP verbs, kita dapat memberikan endpoint GET /articles untuk mendapatkan data artikel atau POST /articles untuk menambahkan artikel.

Gunakan Kata Jamak pada Endpoint untuk Resource Collection

    Nama endpoint harus diberikan dengan kata jamak (plural). Ini disebabkan fakta bahwa data biasanya terdiri dari satu item. Oleh karena itu, menggunakan kata jamak memungkinkan kita untuk konsisten dengan data yang ada di database. Karena tabel database biasanya terdiri lebih dari satu record, atau data.

Lalu, bagaimana jika saya hanya ingin melihat satu data? Contohnya, mendapatkan satu artikel tertentu?

Untuk mendapatkan data spesifik, gunakan path parameter. Contoh yang bagus untuk mendapatkan artikel khusus berdasarkan id adalah end point /articles/:id. Kita akan membahas dan menggunakan path parameter ketika latihan membuat web server.

Gunakan Endpoint berantai untuk resource yang memiliki hirarki/relasi

    Sangat disarankan untuk menulis resource endpoint dari sumber daya yang memiliki hirarki atau korelasi. Untuk tujuan mendapatkan daftar komentar dari sebuah artikel, endpoint

GET /articles/:id/comments adalah pilihan yang tepat.

    Penggunaan endpoint tersebut masuk akal karena prinsipnya memperjelas permintaan klien hanya dengan melihat endpoint yang dituju karena untuk mendapatkan komentar pada respons, kita perlu tahu komentar pada artikel mana yang akan ditampilkan.

Tidak hanya GET, prinsip ini juga cocok diterapkan pada HTTP verb POST, PUT, maupun DELETE.