Membuat API (Application Programming Interface) adalah skill yang sangat berharga di era modern ini. API memungkinkan aplikasi kita untuk berkomunikasi dan berbagi data dengan aplikasi lain, membuka pintu untuk integrasi dan inovasi yang tak terbatas. Jika kamu seorang developer PHP dan ingin meningkatkan kemampuanmu, belajar membuat API dengan Laravel dan JWT (JSON Web Token) adalah langkah yang sangat tepat.
Artikel ini akan membimbingmu langkah demi langkah dalam cara membuat API dengan Laravel dan JWT, lengkap dengan contoh kode yang praktis dan mudah dipahami. Kita akan membahas dari persiapan lingkungan pengembangan, instalasi Laravel, konfigurasi JWT, hingga implementasi endpoint API yang aman dan terautentikasi. Mari kita mulai!
1. Persiapan Lingkungan Pengembangan: Instalasi dan Konfigurasi
Sebelum kita mulai coding, pastikan kamu memiliki lingkungan pengembangan yang siap. Ini termasuk:
- PHP: Pastikan kamu memiliki PHP versi 7.3 atau lebih tinggi. Kamu bisa mengecek versi PHP dengan menjalankan perintah
php -vdi terminal. - Composer: Composer adalah dependency manager untuk PHP. Download dan instal Composer dari https://getcomposer.org/.
- Node.js dan NPM (Optional): Jika kamu berencana menggunakan Laravel Mix untuk mengelola aset front-end, kamu perlu menginstal Node.js dan NPM. Download dari https://nodejs.org/.
- Database: Kamu bisa menggunakan MySQL, PostgreSQL, atau database lain yang didukung oleh Laravel. Pastikan database servermu berjalan.
- Text Editor/IDE: Pilih text editor atau IDE favoritmu. VS Code, Sublime Text, atau PhpStorm adalah pilihan yang populer.
Setelah lingkunganmu siap, mari kita buat proyek Laravel baru:
composer create-project --prefer-dist laravel/laravel jwt-api
cd jwt-apiPerintah ini akan membuat proyek Laravel baru dengan nama jwt-api. Sekarang, kita perlu mengkonfigurasi koneksi database. Buka file .env dan ubah variabel-variabel berikut sesuai dengan konfigurasi database-mu:
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=nama_database
DB_USERNAME=username_database
DB_PASSWORD=password_databasePastikan kamu mengganti nama_database, username_database, dan password_database dengan nilai yang sesuai. Setelah itu, jalankan migrasi awal untuk membuat tabel-tabel dasar:
php artisan migrate2. Menginstal dan Mengkonfigurasi JWT Authentication: Langkah-Langkah Detail
Untuk mengamankan API kita, kita akan menggunakan JWT (JSON Web Token) untuk autentikasi. JWT adalah standar industri untuk membuat token yang aman dan terverifikasi. Kita akan menggunakan package tymon/jwt-auth untuk mengimplementasikan JWT di Laravel.
Pertama, instal package tymon/jwt-auth menggunakan Composer:
composer require tymon/jwt-authSetelah instalasi selesai, publish konfigurasi package ini:
php artisan vendor:publish --provider="TymonJWTAuthProvidersLaravelServiceProvider"Ini akan membuat file konfigurasi config/jwt.php. Selanjutnya, kita perlu menghasilkan secret key untuk JWT:
php artisan jwt:secretPerintah ini akan menghasilkan secret key dan menyimpannya di file .env. Secret key ini digunakan untuk menandatangani token JWT.
Terakhir, kita perlu mengkonfigurasi model User kita untuk menggunakan JWT. Buka file app/Models/User.php dan implementasikan interface TymonJWTAuthContractsJWTSubject:
<?php
namespace AppModels;
use IlluminateContractsAuthMustVerifyEmail;
use IlluminateDatabaseEloquentFactoriesHasFactory;
use IlluminateFoundationAuthUser as Authenticatable;
use IlluminateNotificationsNotifiable;
use LaravelSanctumHasApiTokens;
use TymonJWTAuthContractsJWTSubject;
class User extends Authenticatable implements JWTSubject
{
use HasApiTokens, HasFactory, Notifiable;
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'name',
'email',
'password',
];
/**
* The attributes that should be hidden for serialization.
*
* @var array<int, string>
*/
protected $hidden = [
'password',
'remember_token',
];
/**
* The attributes that should be cast.
*
* @var array<string, string>
*/
protected $casts = [
'email_verified_at' => 'datetime',
];
/**
* Get the identifier that will be stored in the subject claim of the JWT.
*
* @return mixed
*/
public function getJWTIdentifier()
{
return $this->getKey();
}
/**
* Return a key value array, containing any custom claims to be added to the JWT.
*
* @return array
*/
public function getJWTCustomClaims()
{
return [];
}
}Perhatikan bahwa kita menambahkan implements JWTSubject dan mengimplementasikan dua method: getJWTIdentifier() dan getJWTCustomClaims(). Method getJWTIdentifier() mengembalikan ID user, dan getJWTCustomClaims() mengembalikan array custom claims yang ingin kita tambahkan ke token JWT. Dalam contoh ini, kita mengembalikan array kosong karena kita tidak memerlukan custom claims.
3. Membuat Controller Autentikasi: Register dan Login
Sekarang kita akan membuat controller untuk menangani proses autentikasi: registrasi dan login. Buat controller baru dengan perintah:
php artisan make:controller AuthControllerBuka file app/Http/Controllers/AuthController.php dan tambahkan kode berikut:
<?php
namespace AppHttpControllers;
use IlluminateHttpRequest;
use IlluminateSupportFacadesAuth;
use AppModelsUser;
use IlluminateSupportFacadesValidator;
class AuthController extends Controller
{
/**
* Register a User.
*
* @return IlluminateHttpJsonResponse
*/
public function register(Request $request) {
$validator = Validator::make($request->all(), [
'name' => 'required|string|between:2,100',
'email' => 'required|string|email|max:100|unique:users',
'password' => 'required|string|confirmed|min:6',
]);
if($validator->fails()){
return response()->json($validator->errors()->toJson(), 400);
}
$user = User::create(array_merge(
$validator->validated(),
['password' => bcrypt($request->password)]
));
$token = Auth::login($user);
return response()->json([
'message' => 'User successfully registered',
'user' => $user,
'token' => $token
], 201);
}
/**
* Log the user out (Invalidate the token).
*
* @return IlluminateHttpJsonResponse
*/
public function logout() {
auth()->logout();
return response()->json(['message' => 'User successfully signed out']);
}
/**
* Refresh a token.
*
* @return IlluminateHttpJsonResponse
*/
public function refresh() {
return $this->createNewToken(auth()->refresh());
}
/**
* Get the authenticated User.
*
* @return IlluminateHttpJsonResponse
*/
public function userProfile() {
return response()->json(auth()->user());
}
/**
* Get the token array structure.
*
* @param string $token
*
* @return IlluminateHttpJsonResponse
*/
protected function createNewToken($token){
return response()->json([
'access_token' => $token,
'token_type' => 'bearer',
'expires_in' => auth()->factory()->getTTL() * 60,
'user' => auth()->user()
]);
}
/**
* Get a JWT via given credentials.
*
* @return IlluminateHttpJsonResponse
*/
public function login(Request $request){
$validator = Validator::make($request->all(), [
'email' => 'required|email',
'password' => 'required|string|min:6',
]);
if ($validator->fails()) {
return response()->json($validator->errors(), 422);
}
if (! $token = auth()->attempt($validator->validated())) {
return response()->json(['error' => 'Unauthorized'], 401);
}
return $this->createNewToken($token);
}
}Controller ini memiliki beberapa method:
register(): Menerima data registrasi dari request, melakukan validasi, membuat user baru, dan mengembalikan token JWT.login(): Menerima kredensial login (email dan password), mencoba melakukan autentikasi, dan mengembalikan token JWT jika berhasil.logout(): Membatalkan token JWT yang sedang aktif.refresh(): Merefresh token JWT yang kadaluarsa.userProfile(): Mengembalikan data user yang sedang login.createNewToken(): Membangun response JSON yang berisi token JWT, tipe token, masa berlaku token, dan data user.
Perhatikan bahwa kita menggunakan bcrypt() untuk mengenkripsi password saat menyimpan user baru. Kita juga menggunakan Auth::login($user) setelah user berhasil dibuat untuk secara otomatis mengautentikasi user baru.
4. Membuat Route API: Menghubungkan Endpoint ke Controller
Selanjutnya, kita perlu mendefinisikan route API untuk menghubungkan endpoint ke method-method di controller kita. Buka file routes/api.php dan tambahkan kode berikut:
<?php
use IlluminateHttpRequest;
use IlluminateSupportFacadesRoute;
use AppHttpControllersAuthController;
Route::group([
'middleware' => 'api',
'prefix' => 'auth'
], function ($router) {
Route::post('/login', [AuthController::class, 'login']);
Route::post('/register', [AuthController::class, 'register']);
Route::post('/logout', [AuthController::class, 'logout']);
Route::post('/refresh', [AuthController::class, 'refresh']);
Route::post('/user-profile', [AuthController::class, 'userProfile']);
});Kode ini mendefinisikan grup route dengan prefix /auth dan middleware api. Ini berarti semua route di dalam grup ini akan memiliki URL dengan awalan /auth dan akan menggunakan middleware api.
/login: Route untuk endpoint login, dihubungkan ke methodlogin()diAuthController./register: Route untuk endpoint register, dihubungkan ke methodregister()diAuthController./logout: Route untuk endpoint logout, dihubungkan ke methodlogout()diAuthController./refresh: Route untuk endpoint refresh token, dihubungkan ke methodrefresh()diAuthController./user-profile: Route untuk endpoint mendapatkan data user, dihubungkan ke methoduserProfile()diAuthController.
Perhatikan bahwa kita menggunakan Route::post() karena kita akan mengirim data melalui request POST.
5. Implementasi Middleware JWT: Melindungi Endpoint API
Sekarang, mari kita lindungi beberapa endpoint API kita dengan middleware JWT. Kita akan menggunakan middleware auth:api yang disediakan oleh package tymon/jwt-auth. Buka kembali file routes/api.php dan ubah kode berikut:
<?php
use IlluminateHttpRequest;
use IlluminateSupportFacadesRoute;
use AppHttpControllersAuthController;
Route::group([
'middleware' => 'api',
'prefix' => 'auth'
], function ($router) {
Route::post('/login', [AuthController::class, 'login']);
Route::post('/register', [AuthController::class, 'register']);
Route::post('/logout', [AuthController::class, 'logout']);
Route::post('/refresh', [AuthController::class, 'refresh']);
Route::post('/user-profile', [AuthController::class, 'userProfile']);
});
Route::group(['middleware' => 'auth:api'], function () {
Route::get('/protected', function () {
return response()->json(['message' => 'This is a protected route!']);
});
});Kita menambahkan grup route baru dengan middleware auth:api. Ini berarti semua route di dalam grup ini hanya dapat diakses oleh user yang sudah terautentikasi dengan token JWT yang valid.
Kita juga menambahkan route /protected sebagai contoh endpoint yang dilindungi. Endpoint ini hanya akan mengembalikan pesan “This is a protected route!” jika user sudah terautentikasi.
6. Menguji API dengan Postman: Verifikasi Fungsionalitas
Sekarang saatnya untuk menguji API kita. Kita akan menggunakan Postman, sebuah aplikasi populer untuk menguji API.
-
Registrasi User: Buat request POST ke endpoint
http://localhost:8000/api/auth/registerdengan data berikut:{ "name": "John Doe", "email": "[email protected]", "password": "password", "password_confirmation": "password" }Jika berhasil, kamu akan menerima response JSON yang berisi data user dan token JWT.
-
Login User: Buat request POST ke endpoint
http://localhost:8000/api/auth/logindengan data berikut:{ "email": "[email protected]", "password": "password" }Jika berhasil, kamu akan menerima response JSON yang berisi token JWT.
-
Akses Endpoint Terlindungi: Buat request GET ke endpoint
http://localhost:8000/api/protected. Pada tab “Authorization”, pilih “Bearer Token” dan masukkan token JWT yang kamu dapatkan dari proses login.Jika token JWT valid, kamu akan menerima response JSON dengan pesan “This is a protected route!”. Jika tidak valid, kamu akan menerima error 401 Unauthorized.
-
Logout User: Buat request POST ke endpoint
http://localhost:8000/api/auth/logout. Pada tab “Authorization”, pilih “Bearer Token” dan masukkan token JWT yang kamu dapatkan dari proses login.Jika berhasil, kamu akan menerima response JSON dengan pesan “User successfully signed out”.
-
Refresh Token: Buat request POST ke endpoint
http://localhost:8000/api/auth/refresh. Pada tab “Authorization”, pilih “Bearer Token” dan masukkan token JWT yang kamu dapatkan dari proses login.Jika berhasil, kamu akan menerima response JSON yang berisi token JWT baru.
7. Membuat Model dan Migrasi: Menangani Data Produk (Contoh Kasus)
Mari kita buat contoh kasus sederhana untuk mengilustrasikan bagaimana kita bisa membuat endpoint API untuk mengelola data. Kita akan membuat model dan migrasi untuk data produk.
Buat model Product dan migrasi dengan perintah:
php artisan make:model Product -mIni akan membuat file app/Models/Product.php dan file migrasi di folder database/migrations. Buka file migrasi dan ubah kode berikut:
<?php
use IlluminateDatabaseMigrationsMigration;
use IlluminateDatabaseSchemaBlueprint;
use IlluminateSupportFacadesSchema;
return new class extends Migration
{
/**
* Run the migrations.
*/
public function up(): void
{
Schema::create('products', function (Blueprint $table) {
$table->id();
$table->string('name');
$table->text('description')->nullable();
$table->decimal('price', 10, 2);
$table->timestamps();
});
}
/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::dropIfExists('products');
}
};Kita mendefinisikan tabel products dengan kolom-kolom berikut:
id: Primary key (auto-increment).name: Nama produk (string).description: Deskripsi produk (text, nullable).price: Harga produk (decimal).created_atdanupdated_at: Timestamp untuk waktu pembuatan dan pembaruan data.
Jalankan migrasi:
php artisan migrate8. Membuat Controller Produk: CRUD Operations
Sekarang, buat controller ProductController untuk menangani operasi CRUD (Create, Read, Update, Delete) untuk data produk:
php artisan make:controller ProductControllerBuka file app/Http/Controllers/ProductController.php dan tambahkan kode berikut:
<?php
namespace AppHttpControllers;
use AppModelsProduct;
use IlluminateHttpRequest;
use IlluminateSupportFacadesValidator;
class ProductController extends Controller
{
/**
* Display a listing of the resource.
*/
public function index()
{
$products = Product::all();
return response()->json($products);
}
/**
* Store a newly created resource in storage.
*/
public function store(Request $request)
{
$validator = Validator::make($request->all(), [
'name' => 'required|string|max:255',
'description' => 'nullable|string',
'price' => 'required|numeric|min:0',
]);
if ($validator->fails()) {
return response()->json($validator->errors(), 400);
}
$product = Product::create($validator->validated());
return response()->json($product, 201);
}
/**
* Display the specified resource.
*/
public function show(string $id)
{
$product = Product::find($id);
if (!$product) {
return response()->json(['message' => 'Product not found'], 404);
}
return response()->json($product);
}
/**
* Update the specified resource in storage.
*/
public function update(Request $request, string $id)
{
$validator = Validator::make($request->all(), [
'name' => 'string|max:255',
'description' => 'nullable|string',
'price' => 'numeric|min:0',
]);
if ($validator->fails()) {
return response()->json($validator->errors(), 400);
}
$product = Product::find($id);
if (!$product) {
return response()->json(['message' => 'Product not found'], 404);
}
$product->update($validator->validated());
return response()->json($product);
}
/**
* Remove the specified resource from storage.
*/
public function destroy(string $id)
{
$product = Product::find($id);
if (!$product) {
return response()->json(['message' => 'Product not found'], 404);
}
$product->delete();
return response()->json(['message' => 'Product deleted']);
}
}Controller ini memiliki method-method berikut:
index(): Mengembalikan daftar semua produk.store(): Membuat produk baru.show(): Menampilkan detail produk berdasarkan ID.update(): Memperbarui data produk berdasarkan ID.destroy(): Menghapus produk berdasarkan ID.
9. Mendefinisikan Route Produk: Melengkapi Endpoint CRUD
Sekarang, definisikan route API untuk controller produk di file routes/api.php:
<?php
use IlluminateHttpRequest;
use IlluminateSupportFacadesRoute;
use AppHttpControllersAuthController;
use AppHttpControllersProductController;
Route::group([
'middleware' => 'api',
'prefix' => 'auth'
], function ($router) {
Route::post('/login', [AuthController::class, 'login']);
Route::post('/register', [AuthController::class, 'register']);
Route::post('/logout', [AuthController::class, 'logout']);
Route::post('/refresh', [AuthController::class, 'refresh']);
Route::post('/user-profile', [AuthController::class, 'userProfile']);
});
Route::group(['middleware' => 'auth:api'], function () {
Route::get('/protected', function () {
return response()->json(['message' => 'This is a protected route!']);
});
Route::resource('products', ProductController::class);
});Kita menggunakan Route::resource('products', ProductController::class) untuk membuat semua route CRUD untuk controller produk secara otomatis. Ini akan menghasilkan route-route berikut:
GET /api/products: Menampilkan daftar semua produk.POST /api/products: Membuat produk baru.GET /api/products/{product}: Menampilkan detail produk berdasarkan ID.PUT /api/products/{product}: Memperbarui data produk berdasarkan ID.DELETE /api/products/{product}: Menghapus produk berdasarkan ID.
Perhatikan bahwa route-route ini dilindungi oleh middleware auth:api, sehingga hanya user yang sudah terautentikasi yang dapat mengaksesnya.
10. Menguji Endpoint Produk: Melalui Postman
Terakhir, mari kita uji endpoint produk kita menggunakan Postman. Pastikan kamu sudah mendapatkan token JWT yang valid.
-
Dapatkan Daftar Produk: Buat request GET ke endpoint
http://localhost:8000/api/products. Pada tab “Authorization”, pilih “Bearer Token” dan masukkan token JWT. -
Buat Produk Baru: Buat request POST ke endpoint
http://localhost:8000/api/productsdengan data berikut:{ "name": "Produk Baru", "description": "Deskripsi produk baru", "price": 100.00 }Pastikan kamu mengatur header
Content-Typemenjadiapplication/json. Pada tab “Authorization”, pilih “Bearer Token” dan masukkan token JWT. -
Dapatkan Detail Produk: Buat request GET ke endpoint
http://localhost:8000/api/products/{id}(ganti{id}dengan ID produk yang ingin kamu lihat). Pada tab “Authorization”, pilih “Bearer Token” dan masukkan token JWT. -
Perbarui Produk: Buat request PUT ke endpoint
http://localhost:8000/api/products/{id}(ganti{id}dengan ID produk yang ingin kamu perbarui) dengan data berikut:{ "name": "Produk Diperbarui", "price": 150.00 }Pastikan kamu mengatur header
Content-Typemenjadiapplication/json. Pada tab “Authorization”, pilih “Bearer Token” dan masukkan token JWT. -
Hapus Produk: Buat request DELETE ke endpoint
http://localhost:8000/api/products/{id}(ganti{id}dengan ID produk yang ingin kamu hapus). Pada tab “Authorization”, pilih “Bearer Token” dan masukkan token JWT.
11. Validasi Tambahan dan Error Handling: Membuat API Lebih Robust
Untuk membuat API kita lebih robust, kita perlu menambahkan validasi tambahan dan error handling. Beberapa hal yang bisa kita lakukan:
- Validasi Input yang Lebih Ketat: Gunakan validasi yang lebih spesifik untuk memastikan data yang diterima sesuai dengan yang diharapkan.
- Custom Error Messages: Buat pesan error yang lebih jelas dan informatif untuk membantu user memahami masalah yang terjadi.
- Exception Handling: Tangani exception dengan baik dan kembalikan response yang sesuai.
- Rate Limiting: Batasi jumlah request yang dapat dilakukan oleh user dalam periode waktu tertentu untuk mencegah penyalahgunaan API.
12. Dokumentasi API: Pentingnya Informasi yang Jelas
Dokumentasi API adalah bagian penting dari pembuatan API. Dokumentasi yang baik akan membantu developer lain (atau bahkan dirimu sendiri di masa depan) untuk memahami cara menggunakan API kita. Beberapa alat yang bisa kamu gunakan untuk membuat dokumentasi API:
- Swagger/OpenAPI: Standar industri untuk mendefinisikan dan mendokumentasikan API. Kamu bisa menggunakan package seperti
darkaonline/l5-swaggeruntuk menghasilkan dokumentasi Swagger secara otomatis dari kode Laravel kamu. - Postman Collections: Bagikan collection Postmanmu dengan deskripsi yang jelas untuk setiap endpoint.
- ReadMe.io: Platform untuk membuat dokumentasi API yang interaktif dan mudah digunakan.
Dengan mengikuti langkah-langkah di atas, kamu telah berhasil membuat API dengan Laravel dan JWT. Selamat! Kamu sekarang memiliki dasar yang kuat untuk membuat API yang lebih kompleks dan aman. Jangan ragu untuk terus belajar dan bereksperimen dengan fitur-fitur Laravel lainnya. Semoga berhasil!
