RESTful APIs in Laravel

⏱ Estimated reading time: 2 min

RESTful APIs in Laravel allow applications to communicate with other systems using standard HTTP methods and structured data, typically in JSON format. Laravel provides excellent support for building secure, scalable, and well-organized APIs.

1. What Is a RESTful API?

REST (Representational State Transfer) is an architectural style that uses:

• HTTP methods (GET, POST, PUT, DELETE)

• Resources (users, products, posts)

• Stateless communication

• JSON responses

Example endpoints:

GET    /api/posts
POST   /api/posts
GET    /api/posts/{id}
PUT    /api/posts/{id}
DELETE /api/posts/{id}

2. API Routes in Laravel

API routes are defined in:

routes/api.php

• Automatically prefixed with /api

• Stateless (no sessions or cookies)

Example:

Route::get('/users', function () {
    return response()->json([]);
});

3. Creating an API Controller

Create a controller for APIs:

php artisan make:controller Api/PostController

Example controller:

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

class PostController extends Controller
{
    public function index()
    {
        return Post::all();
    }
}

4. Resource Controllers for APIs

Laravel provides API resource controllers:

php artisan make:controller Api/PostController --api

This generates methods:

• index

• store

• show

• update

• destroy

Define routes:

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

5. Request Validation

Validate API requests:

public function store(Request $request)
{
    $request->validate([
        'title' => 'required',
        'content' => 'required',
    ]);

    return Post::create($request->all());
}

6. API Responses

Return JSON responses:

return response()->json([
    'message' => 'Post created successfully',
    'data' => $post
], 201);

7. API Resources (Transformers)

API Resources format responses:

php artisan make:resource PostResource

Example:

return new PostResource($post);

8. Authentication for APIs

Laravel supports API authentication using:

• Sanctum (recommended)

• Passport

Example (Sanctum):

composer require laravel/sanctum

Protect routes:

Route::middleware('auth:sanctum')->group(function () {
    Route::get('/profile', function () {
        return auth()->user();
    });
});

9. API Rate Limiting

Limit requests using middleware:

Route::middleware('throttle:60,1')->group(function () {
    //
});

10. Versioning APIs

Example versioning:

Route::prefix('v1')->group(function () {
    Route::apiResource('posts', PostController::class);
});

11. Error Handling

Laravel automatically returns validation errors in JSON format for API routes.

Example:

{
  "message": "The given data was invalid.",
  "errors": {
    "title": ["The title field is required."]
  }
}

Conclusion

Laravel makes building RESTful APIs simple and efficient. With features like API resource controllers, validation, authentication, and rate limiting, Laravel provides everything needed to create secure, scalable, and well-structured APIs for modern applications.