API Sederhana Laravel

API 😨

Mempelajari API dalam mempelajari pemrograman sangatlah penting, API atau Aplication Programming Interface memiliki beberapa keuntungan atau kelebihan. Beberapa hal terkait keunggulan API antara lain memudahkan pembuatan aplikasi fungsional, efisiensi, meringankan beban server dan beberapa hal lain. API sendiri terbagi ke dalam empat macam yaitu public, private, partner dan composite.

Nah disini kita akan mempelajari membuat sebuah API sederhana menggunakan Laravel. Gass!

Siapkan projeknya

composer create-project api-sederhana

Laravel versi 11

Langkah #1

Membuat sebuah resource

Perintah diatas akan membuat folder baru dalam \Http bernama Resources.

Di dalamnya terbuat fail PostResource.php

Terdapat class PostResource yang mewarisi semua properti dan metode dari JsonResource. Kemudian memiliki method toArray yang berfungsi untuk konversi objek menjadi array.

Langkah #2

Konfigurasi Basis Data

Buka fail .env, di baris 24 ( atau mungkin berbeda ) ubah menjadi seperti berikut ini.

Sesuaikan DB_DATABASE dengan nama basis data yang akan digunakan, sebagai contoh disini menggunakan nama api-laravel

Aplikasi server XAMPP, sehingga otomatis koneksi basis data mysql

Buka phpmyadmin atau gunakan prompt cmd / terminal untuk membuat basis data ( sesuai dengan nama yang ada di baris DB_DATABASE )

Membuat via Command Promt

Membuat via phpmyadmin

Langkah #3

Membuat Model dan Migrasi

Pada bagian ini, jalankan perintah

php artisan make:model Post -m

Fail baru yang akan dibuat bernama Post.php dan sebuah fail migration dengan adanya parameter -m

Dan dalam folder \database\migrations

Tanggal fail migrations akan berubah-ubah menyesuaikan tanggal pembuatan

Tambahkan perintah untuk membuat tabel posts dengan kolom id, nama, alamat dan timestamps

Kolom timestamps bawaan default dari Laravel

Langkah berikutnya, menambahkan perintah fillable atau mass assignment untuk keperluan modifikasi data (insert, update, del).

Buka fail Post.php yang berada di folder \app\Http\Models

Jalankan perintah untuk migrate

php artisan migrate

Buka phpmyadmin atau dengan cmd, akan di dapatkan tabel berhasil dibuat

Cek tabel via phpmyadmin

Cek via Command Prompt

Langkah #4

API Controller

Pada langkah ini, membuat controller untuk menyimpan method-method yang akan digunakan. Baik yang menggunakan POST atau GET

Setelah perintah di jalankan, akan muncul folder baru bernapa Api dalam folder \Http\Controllers\Api yang berisi fail PostController.php

Langkah #5

Route API

Membuat route menggunakan fail apiResource.php yang berada di dalam folder \route

Cek route untuk API

php artisan route:list

Terdapat beberapa method yang bisa digunakan dalam menggunakan API Laravel ini

index method GET untuk mengambil atau menampilkan keseluruhan data.
store method POST digunakan untuk menyimpan data ke dalam basis data.
show method GET digunakan untuk menampilkan data tertentu.
update method PUT digunakan untuk memperbarui data.
destroy method DELETE berfungsi untuk menghapus data.

Masing-masing method tersebut dibuat atau ditulis di fail PostController.php

Misal akan menggunakan method index, yang berfungsi untuk menampilkan data / mengambil data maka ditulis methodnya :

UJI COBA

Langkah terakhir setelah semuanya OK adalah melakukan uji coba terhadap API

Jalankan

php artisan serve

Panggil route /api/post

Hasilnya

Muncul data acak dalam format JSON, tetapi data = [ ] atau masih kosong

Sekarang coba menggunakan Postman

Ketik

localhost:8000/api/post

Dengan method GET

Berhasil!? Bila belum, coba cek lagi step by step dari awal!

Selengkapnya materi API CRUD, akses dengan Git

API Sederhana Laravel - via Postman

Kalau sudah berhasil, kita siap menuju tahap selanjutnya untuk modifikasi data ( CRUD ) sederhana dengan tabel yang berisi kolom id, nama dan alamat diatas 😁😇

#Mangatz 💪