Pada tutorial kali ini kita akan membuat sebuah RESTful API menggunakan Laravel 8. Lebih khususnya, kita akan mengadopsi sebuah framework API yang sudah cukup matang, yaitu Apiato. Menurut yang empunya, Apiato adalah “The open source flawless framework for building scalable and testable API-Centric Apps with PHP and Laravel“, sebuah framework opensource yang secara flawless/tanpa tedeng aling-aling digunakan untuk membangun aplikasi dengan filosofi API-sentris yang skalabel dan testabel dengan menggunakan PHP dan Laravel.
Adapun fitur dari Apiato ini sendiri antara lain:
- Otentifikasi dengan OAuth 2.0
- RBAC (role-based access control) dengan contoh super admin, role dan permission nya
- Query parameter bawaan seperti orderBy, sortedBy dan filter lain
- Ada endpoint khusus untuk mengelola user, role/permission, token dll
- API documentation generator dengan PHP Docblok dan ApiDocJS
- Mendukung CORS (cross-origin resource sharing)
- Mendukung JSONP (JSON with padding) dll
Silakan ikuti series tutorial untuk mengikutinya!
Persiapan
Untuk lebih mudah mengikuti tutorial ini, silakan menyiapkan komputer yang sudah terpasang PHP Composer, Docker Desktop dan IDE favorit, Visual Studio Code.
Buka aplikasi terminal/console/cmd dan buat folder baru dengan nama (misalnya) apiku. kemudian masuk ke dalamnya. cd apiku. Setelah itu buka folder dengan Visual Studio Code.
Kemudian buat satu file docker composer baru dengan isi sebagai berikut:
[sourcecode language=”yaml”]
version: ‘3’
services:
app:
image: panahbiru/php:8.0-apache
links:
– db
ports:
– "8000:80"
volumes:
– ./:/var/www
db:
image: mysql:5.7
environment:
MYSQL_ROOT_PASSWORD: "password"
MYSQL_USER: "admin"
MYSQL_PASSWORD: "password"
MYSQL_DATABASE: "apiku"
ports:
– "33065:3306"
volumes:
– ./mysqldb:/var/lib/mysql
[/sourcecode]
dimana kita akan membuat dua container docker, sebuah web server dengan PHP 8.0 dan database dengan MySQL 5.7. Silakan sesuaikan dengan kebutuhan (username, password, nama DB dll).
setelah disimpan, build stack docker tersebut dengan perintah docker-compose up -d. Tunggu sampai selesai ya, terutama jika image panahbiru/php:8.0-apache dan mysql:5.7 belum ada di docker kamu.
Instalasi Apiato
Untuk instalasi apiato, untuk nama aplikasi apiku, silakan lakukan perintah ini di cmd/terminal:
composer create-project apiato/apiato apiku
tunggu sampai proses download dependensinya selesai.
Migrasi Database
Langkah selanjutnya kita akan melakuan migrasi dan seeding database (pengisian database) dengan template yang sudah disediakan oleh apiato. Caranya, silakan masuk ke container webserver apiato dengan perintah ini:
docker exec -it f4aef310a717e0537837452c9e40d7be756926c4025986e73473ddc6dec61989 /bin/sh
ganti f4aef310a717e0537837452c9e40d7be756926c4025986e73473ddc6dec61989 dengan nama container kamu.
kemudian masuk ke /var/www dan lakukan migrate/seeding
cd /var/www php artisan migrate php artisan db:seed
setelah itu, kita akan membuat user admin yang sudah disediakan, menjadi super admin di platform apiato itu dengan perintah
php artisan apiato:permissions:toRole admin
sekarang, silakan buka browser dan tuju ke alamat port 8000 localhost (atau sesuai yang ada di docker-compose ya).
Silakan coba login ke sana dengan klik tombol login, dan masukkan username: admin@admin.com dan password: admin
langkah terakhir dari instalasi ini adalah membuat encryption key OAuth 2.0 untuk apiato ini. silakan jalankan perintah:
php artisan passport:install
dengan contoh hasil sebagai berikut:
root@f4aef310a717:/var/www# php artisan passport:install Encryption keys generated successfully. Personal access client created successfully. Client ID: 1 Client secret: NLbsaTNxLj0OD2mx8PXaGJTr7k9ShdHZgVw4FjsC Password grant client created successfully. Client ID: 2 Client secret: N0R5ivJ4mjE62E8j1EnVfJUTMU0QXoCYsn71BUu1
segitu dulu ya gan, masuk nanti ke Part 2.