A guide to building RESTful APIs with PHP frameworks

Guidelines for building RESTful APIs using PHP frameworks Choosing a framework: Use a framework like Laravel, such as Laravel. Install Laravel: Install Laravel using the Laravel installer. Define routes: Map URLs to controller actions in routes/api.php. Create a controller: Create a controller in app/Http/Controllers to handle requests and return responses. Handle requests and responses: Use helper methods like response()->json() to simplify responses, and use controller methods to handle requests. Practical case: User API: Create models, controllers and launch APIs to implement user management functions.

Guide to building RESTful API using PHP framework

Introduction

RESTful API (Representational State Transfer) is A popular design style for building APIs that are easy to use, efficient, and extensible. This article guides you through building a RESTful API using the PHP framework.

Choose a Framework

There are many PHP frameworks available for building RESTful APIs, including Laravel, Symfony, and Lumen. This article will use Laravel as an example.

Installing Laravel

composer global require laravel/installer
laravel new my-api

Define routes

Routes are rules that map URLs to controllers and methods. In Laravel, you define API routes in the routes/api.php file.

Route::get('/users', 'UserController@index');
Route::post('/users', 'UserController@store');
Route::get('/users/{user}', 'UserController@show');

Create Controller

The controller handles API requests and returns responses. In Laravel, controllers are located in the app/Http/Controllers directory.

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\User;

class UserController extends Controller
{
    public function index()
    {
        return User::all();
    }

    public function store(Request $request)
    {
        $user = User::create($request->all());

        return response()->json($user, 201);
    }

    public function show(User $user)
    {
        return $user;
    }
}

Handling requests and responses

Controller methods process requests and return responses. Laravel provides various helper methods to simplify this process, such as response()->json() for returning a JSON response.

Practical Case: User API

Let us create a simple user API as a practical case.

Create model

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    protected $fillable = ['name', 'email'];
}

Create controller

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\User;

class UserController extends Controller
{
    public function index()
    {
        return User::all();
    }

    public function store(Request $request)
    {
        $user = User::create($request->all());

        return response()->json($user, 201);
    }

    public function show(User $user)
    {
        return $user;
    }
}

Start API

php artisan serve

Now you can test the API using tools like cURL or Postman:

• Get all users: curl http://localhost:8000/api/users
• Create a new user: curl -X POST -d '{"name": "John", "email": "john@example.com"}' http://localhost:8000/api/users
• Get a specific user: curl http://localhost:8000/api/users/1

The above is the detailed content of A guide to building RESTful APIs with PHP frameworks. For more information, please follow other related articles on the PHP Chinese website!