Bagaimana membuat RESTful API dengan PHP secara mudah?

2014-06-08T09:45:00.001-07:00

Meskipun dunia sudah mendefinisikan RESTful dalam susunan katanya sendiri, seperti juga didefinisikan di Wikipedia, tapi saya lebih senang menggambarkannya dalam pilihan kata sendiri.

Yang akan saya share di sini adalah RESTful yang begini:

Web API
Memiliki base URI, misalnya http://amri.shodiq.me/api/
Menggunakan format dan MIME type tertentu, misalnya JSON atau XML
Menggunakan HTTP method yang standar, yaitu: GET, POST, PUT dan DELETE
Bisa dikelompokkan menjadi 2 jenis, yaitu koleksi dan elemen

Itu saja batasannya. Saya tidak akan menambah batasan lain sementara ini.

Ya, saya tahu di luar sana banyak yang sudah membuat REST dengan CodeIgniter, Laravel atau FuelPHP. Tapi, yang saya ingin share ini cara from scratch-nya. Dan saya tidak akan bicara PHP sebagai bahasa pemrograman object oriented karena itu akan mengacaukan konsep yang ingin saya sampaikan. Ini murni membangun RESTful API dengan PHP, untuk level mahasiswa. Mahasiswa yang rajin belajar.

Nah mari kita bicara detilnya dengan contoh.

Misalnya saya ingin membuat API untuk aplikasi Android saya. Sebuah aplikasi blog sangat sederhana. Saya membuat sebuah database mysql dengan nama blog. Di dalam database blog, saya membuat sebuah table dengan nama posts, untuk menyimpan blog post saya. Kurang lebih strukturnya seperti berikut:

Pada poin nomor 5, saya menyebutkan ada koleksi dan ada elemen. Perbedaan antara keduanya lebih mudah digambarkan seperti berikut ini:

Koleksi
Struktur: http://amri.shodiq.me/api/blog/
Contoh: http://amri.shodiq.me/api/blog/posts
Dalam URI semacam ini, maka sewajarnya jika API ini memberikan data berupa beberapa data post terahir blog saya.
Elemen
Struktur: http://amri.shodiq.me/api/blog//
Contoh: http://amri.shodiq.me/api/blog/posts/10
Dalam URI semacam ini, maka API akan memberikan data detil blog post saya dengan ID 10.

Nah, di atas saya sudah merencakan 2 URI yang akan saya buat menjadi API. Satu adalah API untuk koleksi posts dan satu lagi untuk satu elemen post. Mudah-mudahan Anda bisa menangkap ide nya.

Dalam RESTful, HTTP method yang digunakan pun sudah mencerminkan apa yang ingin Anda lakukan.

Contoh kasus nya, dengan menggunakan URI http://amri.shodiq.me/api/blog/posts. Ini artinya kita bekerja pada level koleksi.

Jika saya menggunakan HTTP method GET, maka server akan membaca database, lalu mengambil beberapa data terakhir dari table posts, kemudian memberikannya sebagai response dalam format yang diminta, misalnya JSON.
Jika saya menggunakan HTTP method POST, maka server akan berharap bahwa kita akan memberikan beberapa parameter yang akan disimpan ke dalam table posts. Dalam hal ini parameter yang ditunggu oleh server misalnya title dan body. Jika dua parameter ini ditemukan, maka server akan membuat data baru ke dalam table posts, mengambil ID post tersebut, dan merekonstruksikannya menjadi sebuah URI, misalnya http://amri.shodiq.me/api/blog/posts/11. URI ini kemudian akan diberikan sebagai response.
Jika saya menggunakan HTTP method PUT, maka server akan menganggap ini sebagai perintah untuk mengganti/mengupdate seluruh isi table posts dengan konten yang baru, sesuai parameter PUT yang dikirim.
Jika saya menggunakan HTTP metho DELETE, maka server akan menganggap ini sebagai perintah untuk mengosongkan table posts.

Contoh di atas adalah kondisi yang diharapkan ketika kita bekerja pada lebel koleksi. Berbeda lagi jika kita ingin bekerja pada level elemen. Saya tidak akan menjelaskan lebih jauh tentang bagaimana untuk server me-response GET, POST, PUT dan DELETE pada titik ini, karena nantinya akan saya detilkan di bawah.

Sampai titik ini rencananya sudah semakin matang. Saya sudah akan memiliki 4 fungsi untuk 1 URI koleksi. Berikutnya kita akan bicara langkah demi langkah mengimplementasikan API-nya. Sampai tahap ini saya berharap Anda sudah cukup mengerti bagaimana menginstall PHP dan MySQL, karena saya tidak akan mengulas tentang instalasi. Langsung coding.

Sekedar Mencoba Berbagi Manfaat Pengetahuan

Bagaimana membuat RESTful API dengan PHP secara mudah?