Routing API dan Controller Resouce - Perwira Learning Center

Al Zaki Ibra Ramadani Februari 24, 2026

 

1. LATAR BELAKANG

    Setelah memahami konsep dasar Laravel sebagai REST API framework pada artikel sebelumnya, langkah berikutnya yang krusial adalah mempelajari bagaimana cara merancang dan mengelola rute (routing) API serta menghubungkannya dengan controller. Routing adalah "peta jalan" dari API kita, ia menentukan bagaimana client dapat mengakses sumber daya yang tersedia di server.

Pada hari kedua minggu ini, saya mendalami bagaimana Laravel menangani HTTP request melalui file routes/api.php. Fokus utamanya adalah memahami konsep RESTful routing, di mana setiap endpoint merepresentasikan sebuah sumber daya (resource) dan method HTTP (GET, POST, PUT, DELETE) merepresentasikan aksi yang ingin dilakukan terhadap sumber daya tersebut.

Yang paling menarik adalah fitur Route::apiResource() yang dimiliki Laravel. Dengan satu baris kode, kita bisa membuat 7 endpoint RESTful sekaligus! Ini sangat menghemat waktu dan memastikan konsistensi dalam pengembangan API.

2. ALAT DAN BAHAN

2.1 Perangkat Lunak

  • Visual Studio Code - Dengan ekstensi Laravel Artisan, PHP Intelephense
  • Laravel 12 - Project yang sudah terinstall dan terkonfigurasi
  • Postman/Thunder Client - Untuk testing endpoint API
  • Git Bash/Terminal - Untuk menjalankan perintah Artisan
  • Composer - Manajemen dependensi

2.2 Perangkat Keras

  • Laptop dengan spesifikasi minimal untuk menjalankan Laravel

3. PEMBAHASAN

3.1 Memahami Konsep RESTful API untuk Resource

    Sebelum masuk ke kode, penting untuk memahami bagaimana sebuah sumber daya (resource) dipetakan ke dalam endpoint API. Misalkan kita memiliki resource Posts (artikel/blog post). Maka operasi CRUD-nya akan dipetakan sebagai berikut:

HTTP MethodURLNama Route Deskripsi 
GET/api/postsposts.indexMengambil daftar semua post
POST/api/postsposts.storeMembuat post baru
GET/api/posts/{id}posts.showMengambil detail satu post
PUT/PATCH/api/posts/{id}posts.updateMengupdate post
DELETE/api/posts/{id}posts.destroyMenghapus post

Pemetaan ini adalah standar industri yang dikenal sebagai RESTful API conventions. Laravel mengikuti standar ini dengan sangat baik.

3.2 File routes/api.php dan Perbedaannya dengan web.php

Mari kita lihat struktur dasar file routes/api.php:

Yang perlu diperhatikan:

  1. Semua route otomatis memiliki prefix /api (jadi /api/posts, bukan /posts)
  2. Laravel secara default menerapkan middleware api yang mencakup: 
    • Rate limiting (membatasi jumlah request)
    • CORS configuration
    • Stateless (tanpa session)
  3. Nama route otomatis dibuat dengan format resource.action (misal: posts.index)

3.3 Keajaiban Route::apiResource()

Inilah fitur yang membuat Laravel sangat produktif untuk pengembangan API. Mari kita bedah apa yang terjadi dengan satu baris kode ini:

Secara otomatis, Laravel akan mendaftarkan 5 route berikut (karena apiResource tidak menyertakan route create dan edit yang biasanya untuk form HTML):

Opsi yang bisa digunakan dengan apiResource:

3.4 Membuat Controller Khusus API

Laravel menyediakan perintah Artisan untuk membuat controller yang sudah dilengkapi dengan method-method untuk API Resource:

bash
# Membuat controller kosong
php artisan make:controller Api/PostController

# Membuat controller dengan method untuk resource (recommended)
php artisan make:controller Api/PostController --api

# Membuat controller dengan model dan resource (lebih advanced)
php artisan make:controller Api/PostController --api --model=Post

Mari kita lihat struktur controller yang dihasilkan dari perintah --api:

php
<?php
// File: app/Http/Controllers/Api/PostController.php

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;

class PostController extends Controller
{
    /**
     * GET /api/posts
     * Menampilkan daftar semua post
     */
    public function index()
    {
        // Ambil semua data post
        $posts = Post::all();
        
        // Return response JSON
        return response()->json([
            'success' => true,
            'message' => 'Daftar semua post',
            'data' => $posts
        ]);
    }

    /**
     * POST /api/posts
     * Menyimpan post baru
     */
    public function store(Request $request)
    {
        // Validasi data
        $validated = $request->validate([
            'title' => 'required|max:255',
            'content' => 'required',
            'category_id' => 'required|exists:categories,id'
        ]);

        // Buat post baru
        $post = Post::create($validated);

        // Return response dengan status 201 (Created)
        return response()->json([
            'success' => true,
            'message' => 'Post berhasil dibuat',
            'data' => $post
        ], 201);
    }

    /**
     * GET /api/posts/{post}
     * Menampilkan detail satu post
     */
    public function show(Post $post)
    {
        // Menggunakan route model binding, $post sudah terisi otomatis
        return response()->json([
            'success' => true,
            'message' => 'Detail post',
            'data' => $post
        ]);
    }

    /**
     * PUT/PATCH /api/posts/{post}
     * Mengupdate post yang sudah ada
     */
    public function update(Request $request, Post $post)
    {
        // Validasi data
        $validated = $request->validate([
            'title' => 'sometimes|required|max:255',
            'content' => 'sometimes|required',
            'category_id' => 'sometimes|required|exists:categories,id'
        ]);

        // Update post
        $post->update($validated);

        return response()->json([
            'success' => true,
            'message' => 'Post berhasil diupdate',
            'data' => $post
        ]);
    }

    /**
     * DELETE /api/posts/{post}
     * Menghapus post
     */
    public function destroy(Post $post)
    {
        // Hapus post
        $post->delete();

        // Return response tanpa data (status 200 OK)
        return response()->json([
            'success' => true,
            'message' => 'Post berhasil dihapus'
        ]);
    }
}

3.5 Route Model Binding yang Elegan

Perhatikan pada method show(Post $post). Laravel secara otomatis akan mencari post berdasarkan ID yang dikirim di URL. Jika tidak ditemukan, otomatis mengembalikan response 404. Ini disebut Route Model Binding.

Contoh:

  • Request ke GET /api/posts/5
  • Laravel akan mencari post dengan ID = 5 di tabel posts
  • Jika ditemukan, object Post akan di-inject ke parameter $post
  • Jika tidak ditemukan, otomatis return 404

3.6 Testing Endpoint dengan Postman

Mari kita lihat bagaimana cara menguji setiap endpoint yang telah kita buat:

1. GET /api/posts

text
Method: GET
URL: http://localhost:8000/api/posts
Response:
{
    "success": true,
    "message": "Daftar semua post",
    "data": [
        {
            "id": 1,
            "title": "Belajar Laravel API",
            "content": "Content...",
            "created_at": "2026-02-24T..."
        }
    ]
}

2. POST /api/posts

text
Method: POST
URL: http://localhost:8000/api/posts
Headers: Content-Type: application/json
Body (raw JSON):
{
    "title": "Post Baru",
    "content": "Ini adalah konten post baru",
    "category_id": 1
}

Response (201 Created):
{
    "success": true,
    "message": "Post berhasil dibuat",
    "data": {
        "id": 4,
        "title": "Post Baru",
        "content": "Ini adalah konten post baru",
        "category_id": 1,
        "updated_at": "2026-02-24T...",
        "created_at": "2026-02-24T..."
    }
}

3. GET /api/posts/4

text
Method: GET
URL: http://localhost:8000/api/posts/4

Response:
{
    "success": true,
    "message": "Detail post",
    "data": {
        "id": 4,
        "title": "Post Baru",
        "content": "Ini adalah konten post baru",
        "category_id": 1,
        "created_at": "2026-02-24T..."
    }
}

4. PUT /api/posts/4

text
Method: PUT
URL: http://localhost:8000/api/posts/4
Headers: Content-Type: application/json
Body:
{
    "title": "Post Baru (Updated)",
    "content": "Konten yang sudah diupdate"
}

Response:
{
    "success": true,
    "message": "Post berhasil diupdate",
    "data": {
        "id": 4,
        "title": "Post Baru (Updated)",
        "content": "Konten yang sudah diupdate",
        "category_id": 1
    }
}

5. DELETE /api/posts/4

text
Method: DELETE
URL: http://localhost:8000/api/posts/4

Response:
{
    "success": true,
    "message": "Post berhasil dihapus"
}

3.7 Menambahkan Endpoint Kustom

Terkadang kita membutuhkan endpoint yang tidak mengikuti pola resource standar. Untuk kasus ini, kita bisa menambahkan route kustom:

php
// routes/api.php

// Endpoint untuk mengambil post berdasarkan kategori
Route::get('/categories/{category}/posts', [PostController::class, 'postsByCategory']);

// Endpoint untuk mencari post
Route::get('/posts/search/{keyword}', [PostController::class, 'search']);

// Endpoint untuk post trending
Route::get('/posts/trending', [PostController::class, 'trending']);

Di controller:

php
public function postsByCategory($categoryId)
{
    $posts = Post::where('category_id', $categoryId)->get();
    
    return response()->json([
        'success' => true,
        'data' => $posts
    ]);
}

3.8 Mengelompokkan Route

Untuk API yang besar, kita bisa mengelompokkan route berdasarkan fitur atau versi:

php
// routes/api.php

// API Version 1
Route::prefix('v1')->group(function () {
    
    // Public routes
    Route::apiResource('posts', PostController::class)->only(['index', 'show']);
    
    // Protected routes (akan ditambahkan middleware auth nanti)
    Route::middleware('auth:sanctum')->group(function () {
        Route::apiResource('posts', PostController::class)->except(['index', 'show']);
        Route::apiResource('users', UserController::class);
    });
    
});

// API Version 2 (dengan perubahan/perbaikan)
Route::prefix('v2')->group(function () {
    // Endpoint yang lebih baru
});

3.9 Melihat Daftar Route

Laravel menyediakan perintah untuk melihat semua route yang terdaftar:

bash
php artisan route:list

# Untuk melihat route API saja
php artisan route:list --path=api

# Untuk melihat route yang lebih detail
php artisan route:list -v

Outputnya akan seperti ini:

text
GET|HEAD  api/posts ................ posts.index › Api\PostController@index
POST      api/posts ................ posts.store › Api\PostController@store
GET|HEAD  api/posts/{post} .......... posts.show › Api\PostController@show
PUT|PATCH api/posts/{post} ........ posts.update › Api\PostController@update
DELETE    api/posts/{post} ....... posts.destroy › Api\PostController@destroy

3.10 Response JSON yang Konsisten

Penting untuk menjaga konsistensi struktur response JSON di seluruh endpoint. Contoh format yang umum digunakan:

php
// Success response
return response()->json([
    'success' => true,
    'message' => 'Operasi berhasil',
    'data' => $data,
    'meta' => [
        'total' => $total,
        'per_page' => $perPage
    ]
]);

// Error response
return response()->json([
    'success' => false,
    'message' => 'Terjadi kesalahan',
    'errors' => $errors
], 400);

3.11 Kendala dan Solusi

Kendala yang Dihadapi:

  1. Bingung membedakan PUT vs PATCH - PUT untuk update seluruh data, PATCH untuk update sebagian
  2. Route model binding error - Lupa mengimpor model di controller
  3. Testing dengan Postman - Lupa mengatur header Content-Type: application/json

Solusi yang Diterapkan:

  1. Membuat tabel referensi HTTP method dan fungsinya
  2. Selalu cek use statement di bagian atas controller
  3. Membuat collection di Postman untuk menyimpan semua endpoint dengan header yang sudah terkonfigurasi

4. KESIMPULAN

Routing dan controller adalah jantung dari sebuah REST API. Laravel menyediakan alat yang sangat powerfull dan produktif melalui:

  1. Route::apiResource() - Membuat 5 endpoint RESTful hanya dengan satu baris kode
  2. API Resource Controller - Struktur method yang sudah sesuai dengan operasi CRUD
  3. Route Model Binding - Otomatis mengambil model berdasarkan ID di URL
  4. Response JSON - Mudah mengembalikan data dalam format JSON

Dengan pemahaman ini, kita sudah bisa membangun fondasi API yang solid. Pada artikel selanjutnya, kita akan belajar tentang Database, Migration, dan Eloquent ORM untuk menghubungkan API kita dengan database yang sesungguhnya.

5. DAFTAR PUSTAKA

  1. Laravel Official Documentation. (n.d.). Laravel 12.x Documentation - Controllers. https://laravel.com
  2. Laravel Official Documentation. (n.d.). Laravel 12.x Documentation - Routing. https://laravel.com
  3. Parsinta_. (2022). 3 Metode Laravel Routing Yang Sering Digunakan: Panduan Lengkap. https://parsinta.com
  4. Course-Net. (2024). Routing Dan Controller Pada Laravel. https://course-net.com


Al Zaki Ibra Ramadani

Diposting oleh Al Zaki Ibra Ramadani

Posting Komentar

0 Komentar