API resource controllers in Laravel

Introduction

API resource controllers help organize your code to handle common actions like listing, creating, updating, and deleting data in a clean way.

When building a RESTful API to manage data like users, posts, or products.

When you want to keep your controller code simple and follow a standard pattern.

When you need to quickly create endpoints for CRUD (Create, Read, Update, Delete) operations.

When you want Laravel to automatically handle routing for common API actions.

Syntax

Laravel

php artisan make:controller NameController --api

// In routes/api.php
Route::apiResource('names', NameController::class);

The --api flag creates a controller without methods for showing forms, since APIs usually don't need HTML forms.

The apiResource method sets up routes for index, store, show, update, and destroy actions automatically.

Examples

This command creates a controller for API actions related to products.

Laravel

php artisan make:controller ProductController --api

This sets up API routes for products, like GET /products and POST /products.

Laravel

Route::apiResource('products', ProductController::class);

This is a simple API resource controller with all main methods for managing products.

Laravel

<?php

namespace AppHttpControllers;

use AppModelsProduct;
use IlluminateHttpRequest;

class ProductController extends Controller
{
    public function index()
    {
        return Product::all();
    }

    public function store(Request $request)
    {
        return Product::create($request->all());
    }

    public function show(Product $product)
    {
        return $product;
    }

    public function update(Request $request, Product $product)
    {
        $product->update($request->all());
        return $product;
    }

    public function destroy(Product $product)
    {
        $product->delete();
        return response()->noContent();
    }
}

Sample Program

This example shows a TaskController with all API resource methods. The routes/api.php file uses apiResource to create routes automatically for tasks.

Laravel

<?php

namespace AppHttpControllers;

use AppModelsTask;
use IlluminateHttpRequest;

class TaskController extends Controller
{
    public function index()
    {
        return Task::all();
    }

    public function store(Request $request)
    {
        return Task::create($request->all());
    }

    public function show(Task $task)
    {
        return $task;
    }

    public function update(Request $request, Task $task)
    {
        $task->update($request->all());
        return $task;
    }

    public function destroy(Task $task)
    {
        $task->delete();
        return response()->noContent();
    }
}

// In routes/api.php
use AppHttpControllers\TaskController;

Route::apiResource('tasks', TaskController::class);

Important Notes

API resource controllers do not include methods for creating or editing forms because APIs usually work with JSON data.

Use route model binding (like Task $task) to automatically get the model instance from the URL.

Remember to add validation in the store and update methods to keep data safe.

Summary

API resource controllers organize common API actions in one place.

Use php artisan make:controller NameController --api to create one quickly.

Use Route::apiResource to set up routes automatically for your API.

Practice

1. What is the main purpose of an API resource controller in Laravel?

easy

A. To manage database migrations automatically

B. To handle user authentication and sessions

C. To generate HTML views for web pages

D. To provide standard methods for RESTful API actions like index, show, store, update, and destroy

Solution

1. Step 1: Understand the role of API resource controllers

   API resource controllers in Laravel provide a set of predefined methods that correspond to common RESTful API actions such as listing resources, showing a single resource, creating, updating, and deleting resources.

2. Step 2: Compare with other options

   Options A, B, and D describe other Laravel features unrelated to API resource controllers. Authentication, migrations, and HTML views are handled differently.

3. Final Answer:

   To provide standard methods for RESTful API actions like index, show, store, update, and destroy -> Option D

4. Quick Check:

   API resource controller purpose = standard RESTful methods [OK]

Hint: API resource controllers map REST actions automatically [OK]

Common Mistakes:

• Confusing API controllers with authentication controllers
• Thinking API resource controllers generate views
• Assuming they handle database migrations

2. Which of the following is the correct way to register an API resource controller route in Laravel?

easy

A. Route::getResource('posts', PostController::class);

B. Route::resource('posts', PostController::class);

C. Route::apiResource('posts', PostController::class);

D. Route::api('posts', PostController::class);

Solution

1. Step 1: Identify the method for API resource routes

   Laravel provides the apiResource method to register routes for API resource controllers, which excludes routes for creating and editing views.

2. Step 2: Check other options

   Route::resource('posts', PostController::class); registers a full resource controller including web routes for create/edit views, which is not typical for APIs. Options C and D are invalid Laravel route methods.

3. Final Answer:

   Route::apiResource('posts', PostController::class); -> Option C

4. Quick Check:

   API resource route method = apiResource [OK]

Hint: Use apiResource for API-only routes, not resource [OK]

Common Mistakes:

• Using Route::resource instead of Route::apiResource for APIs
• Using non-existent route methods like getResource
• Confusing web and API route registration

3. Given this API resource controller method in Laravel:

public function show($id) {
    return response()->json(['id' => $id, 'name' => 'Item '.$id]);
}

What will be the JSON response when calling GET /api/items/5?

medium

A. {"id":"5", "name":"Item 5"}

B. {"error":"Not Found"}

C. {"id":null, "name":"Item 5"}

D. {"id":5, "name":"Item 5"}

Solution

1. Step 1: Analyze the show method

   The method returns a JSON response with an array containing 'id' set to the passed $id parameter and 'name' as 'Item ' concatenated with $id.

2. Step 2: Substitute the URL parameter

   Calling GET /api/items/5 passes '5' as $id (string), so the JSON will be {"id":"5", "name":"Item 5"}.

3. Final Answer:

   {"id":"5", "name":"Item 5"} -> Option A

4. Quick Check:

   show method returns JSON with id="5" [OK]

Hint: Check parameter passed matches JSON output exactly [OK]

Common Mistakes:

• Assuming id is integer instead of string
• Expecting an error response for valid id
• Confusing JSON structure returned

4. You have this route registration:

Route::apiResource('products', ProductController::class);

But when you try to access GET /products/create, you get a 404 error. Why?

medium

A. Because the ProductController is missing the create method

B. Because apiResource does not create routes for create and edit methods

C. Because the route URL is incorrect and should be /product/create

D. Because GET requests are not allowed on apiResource routes

Solution

1. Step 1: Understand apiResource route behavior

   The apiResource method registers only API routes and excludes routes for creating and editing resources, such as /create and /edit, which are typically used for web forms.

2. Step 2: Analyze the 404 error cause

   Since /products/create route is not registered by apiResource, accessing it results in a 404 error. This is expected behavior.

3. Final Answer:

   Because apiResource does not create routes for create and edit methods -> Option B

4. Quick Check:

   apiResource excludes create/edit routes [OK]

Hint: apiResource skips create/edit routes, use resource for them [OK]

Common Mistakes:

• Expecting create route with apiResource
• Thinking route URL is wrong
• Assuming GET requests are blocked

5. You want to create an API resource controller that only supports index and show methods to list and view items. Which is the best way to register the routes?

hard

A. Route::apiResource('items', ItemController::class)->only(['index', 'show']);

B. Route::resource('items', ItemController::class)->except(['store', 'update', 'destroy']);

C. Route::apiResource('items', ItemController::class)->except(['create', 'edit']);

D. Route::resource('items', ItemController::class)->only(['index', 'show', 'create']);

Solution

1. Step 1: Identify the correct route registration method for APIs

   Since this is an API controller, apiResource is preferred because it excludes create/edit routes automatically.

2. Step 2: Limit routes to only index and show

   The only method restricts the registered routes to just the specified methods, here 'index' and 'show'.

3. Step 3: Evaluate other options

   Route::resource('items', ItemController::class)->except(['store', 'update', 'destroy']); uses resource which includes web routes unnecessarily. Route::apiResource('items', ItemController::class)->except(['create', 'edit']); excludes create/edit but does not limit to only index/show. Route::resource('items', ItemController::class)->only(['index', 'show', 'create']); includes 'create' which is not needed and uses resource.

4. Final Answer:

   Route::apiResource('items', ItemController::class)->only(['index', 'show']); -> Option A

5. Quick Check:

   Use apiResource with only(['index', 'show']) for limited API routes [OK]

Hint: Use apiResource with only() to limit API routes [OK]

Common Mistakes:

• Using resource instead of apiResource for APIs
• Not limiting routes and exposing unwanted methods
• Including create/edit routes in API