Create a Laravel project and configure the database environment; 2. Use Artisan to generate models, migrations and controllers; 3. Define API resource routing in api.php; 4. Implement the addition, deletion, modification and query methods in the controller and use request verification; 5. Install Laravel Sanctum to implement API authentication and protect routes; 6. Unify JSON response format and handle errors; 7. Use Postman and other tools to test the API, and finally obtain a complete and extensible RESTful API.
Creating a RESTful API with Laravel is straightforward thanks to its built-in tools for routing, controllers, Eloquent ORM, and request validation. Here's a step-by-step guide to help you build a clean and functional REST API.
1. Set Up Laravel and Configure the Environment
Start by creating a new Laravel project (if you haven't already):
composer create-project laravel/laravel api-project cd api-project
Make sure your .env file is configured with the correct database settings:
DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=your_database_name DB_USERNAME=your_db_username DB_PASSWORD=your_db_password
Then run migrations to set up basic tables (like users):
php artisan migrate
2. Create a Model, Migration, and Controller
Let's say you want to build an API for managing posts . Use Artisan to generate everything at once:
php artisan make:model Post -mcr
-
-mcreates a migration -
-ccreates a controller -
-radds resource methods (for REST)
Open the migration file in database/migrations and define your table fields:
// In the migration file
public function up()
{
Schema::create('posts', function (Blueprint $table) {
$table->id();
$table->string('title');
$table->text('body');
$table->foreignId('user_id')->constrained();
$table->timestamps();
});
}Run the migration:
php artisan migrate
3. Define API Routes
In routes/api.php , define resourceful routes:
use App\Http\Controllers\PostController; Route::apiResource('posts', PostController::class);
Laravel automatically maps CRUD operations to the appropriate HTTP methods:
-
GET /api/posts→ index -
POST /api/posts→ store -
GET /api/posts/{id}→ show -
PUT/PATCH /api/posts/{id}→ update -
DELETE /api/posts/{id}→ destroy
4. Implement the Controller Methods
Open app/Http/Controllers/PostController.php and fill in the methods:
use App\Models\Post;
use Illuminate\Http\Request;
public function index()
{
return response()->json(Post::with('user')->get());
}
public function store(Request $request)
{
$validated = $request->validate([
'title' => 'required|string|max:255',
'body' => 'required',
]);
$post = auth()->user()->posts()->create($validated);
return response()->json($post, 201);
}
public function show(Post $post)
{
return response()->json($post->load('user'));
}
public function update(Request $request, Post $post)
{
$request->validate([
'title' => 'sometimes|required|string|max:255',
'body' => 'sometimes|required',
]);
$post->update($request->only(['title', 'body']));
return response()->json($post);
}
public function destroy(Post $post)
{
$post->delete();
return response()->json(null, 204);
} Note: We're using route model binding — Laravel automatically injects the Post model based on the ID in the URL.
5. Add Authentication (Optional but Recommended)
For secure APIs, use Laravel Sanctum:
composer requires laravel/sanctum
Publish Sanctum's configuration:
php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"
Run the migration:
php artisan migrate
Add the Sanctum middleware in app/Http/Kernel.php under 'api' :
'auth:sanctum',
Now protect your routes:
Route::middleware('auth:sanctum')->group(function () {
Route::apiResource('posts', PostController::class);
});Users can log in via an authentication endpoint to get an API token.
6. Format Responses and Handle Errors
Use consistent JSON responses. Laravel automatically wraps data in data if you use API resources, but for simplicity, response()->json() works fine.
For error handling, Laravel's Handler.php ( app/Exceptions/Handler.php ) will catch validation and server errors and return JSON responses automatically when requesting via API.
You can also create API resource classes for more control:
php artisan make:resource PostResource
7. Test Your API
Use tools like Postman , Thunder Client (VS Code) , or curl to test endpoints.
Example: Create a post
POST /api/posts
Headers:
Authorization: Bearer <token>
Content-Type: application/json
Body:
{
"title": "My First Post",
"body": "This is the content."
}Final Tips
- Always validate input.
- Use HTTP status codes appropriately (200, 201, 404, 422, etc.).
- Include relationships using
with()orload(). - Version your API (eg,
/api/v1/posts) as it grows. - Consider using API resources for complex data formatting.
That's it. You now have a fully functional RESTful API with Laravel. It's clean, scalable, and ready for frontend or mobile integration.
The above is the detailed content of How to create a RESTful API with Laravel?. For more information, please follow other related articles on the PHP Chinese website!
Hot AI Tools
Undress AI Tool
Undress images for free
Undresser.AI Undress
AI-powered app for creating realistic nude photos
AI Clothes Remover
Online AI tool for removing clothes from photos.
Clothoff.io
AI clothes remover
Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!
Hot Article
Hot Tools
Notepad++7.3.1
Easy-to-use and free code editor
SublimeText3 Chinese version
Chinese version, very easy to use
Zend Studio 13.0.1
Powerful PHP integrated development environment
Dreamweaver CS6
Visual web development tools
SublimeText3 Mac version
God-level code editing software (SublimeText3)
Hot Topics
How to set environment variables in PHP environment Description of adding PHP running environment variables
Jul 25, 2025 pm 08:33 PM
There are three main ways to set environment variables in PHP: 1. Global configuration through php.ini; 2. Passed through a web server (such as SetEnv of Apache or fastcgi_param of Nginx); 3. Use putenv() function in PHP scripts. Among them, php.ini is suitable for global and infrequently changing configurations, web server configuration is suitable for scenarios that need to be isolated, and putenv() is suitable for temporary variables. Persistence policies include configuration files (such as php.ini or web server configuration), .env files are loaded with dotenv library, and dynamic injection of variables in CI/CD processes. Security management sensitive information should be avoided hard-coded, and it is recommended to use.en
How to make PHP container support automatic construction? Continuously integrated CI configuration method of PHP environment
Jul 25, 2025 pm 08:54 PM
To enable PHP containers to support automatic construction, the core lies in configuring the continuous integration (CI) process. 1. Use Dockerfile to define the PHP environment, including basic image, extension installation, dependency management and permission settings; 2. Configure CI/CD tools such as GitLabCI, and define the build, test and deployment stages through the .gitlab-ci.yml file to achieve automatic construction, testing and deployment; 3. Integrate test frameworks such as PHPUnit to ensure that tests are automatically run after code changes; 4. Use automated deployment strategies such as Kubernetes to define deployment configuration through the deployment.yaml file; 5. Optimize Dockerfile and adopt multi-stage construction
How to develop AI intelligent form system with PHP PHP intelligent form design and analysis
Jul 25, 2025 pm 05:54 PM
When choosing a suitable PHP framework, you need to consider comprehensively according to project needs: Laravel is suitable for rapid development and provides EloquentORM and Blade template engines, which are convenient for database operation and dynamic form rendering; Symfony is more flexible and suitable for complex systems; CodeIgniter is lightweight and suitable for simple applications with high performance requirements. 2. To ensure the accuracy of AI models, we need to start with high-quality data training, reasonable selection of evaluation indicators (such as accuracy, recall, F1 value), regular performance evaluation and model tuning, and ensure code quality through unit testing and integration testing, while continuously monitoring the input data to prevent data drift. 3. Many measures are required to protect user privacy: encrypt and store sensitive data (such as AES
What is Configuration Caching in Laravel?
Jul 27, 2025 am 03:54 AM
Laravel's configuration cache improves performance by merging all configuration files into a single cache file. Enabling configuration cache in a production environment can reduce I/O operations and file parsing on each request, thereby speeding up configuration loading; 1. It should be enabled when the application is deployed, the configuration is stable and no frequent changes are required; 2. After enabling, modify the configuration, you need to re-run phpartisanconfig:cache to take effect; 3. Avoid using dynamic logic or closures that depend on runtime conditions in the configuration file; 4. When troubleshooting problems, you should first clear the cache, check the .env variables and re-cache.
How to use PHP combined with AI to analyze video content PHP intelligent video tag generation
Jul 25, 2025 pm 06:15 PM
The core idea of PHP combining AI for video content analysis is to let PHP serve as the backend "glue", first upload video to cloud storage, and then call AI services (such as Google CloudVideoAI, etc.) for asynchronous analysis; 2. PHP parses the JSON results, extract people, objects, scenes, voice and other information to generate intelligent tags and store them in the database; 3. The advantage is to use PHP's mature web ecosystem to quickly integrate AI capabilities, which is suitable for projects with existing PHP systems to efficiently implement; 4. Common challenges include large file processing (directly transmitted to cloud storage with pre-signed URLs), asynchronous tasks (introducing message queues), cost control (on-demand analysis, budget monitoring) and result optimization (label standardization); 5. Smart tags significantly improve visual
How to build a content payment platform through PHP How to implement PHP paid reading system
Jul 25, 2025 pm 06:30 PM
To build a PHP content payment platform, it is necessary to build a user management, content management, payment and permission control system. First, establish a user authentication system and use JWT to achieve lightweight authentication; second, design the backend management interface and database fields to manage paid content; third, integrate Alipay or WeChat payment and ensure process security; fourth, control user access rights through session or cookies. Choosing the Laravel framework can improve development efficiency, use watermarks and user management to prevent content theft, optimize performance requires coordinated improvement of code, database, cache and server configuration, and clear policies must be formulated and malicious behaviors must be prevented.
PHP development user permission management monetization PHP permission control and role management
Jul 25, 2025 pm 06:51 PM
User permission management is the core mechanism for realizing product monetization in PHP development. It separates users, roles and permissions through a role-based access control (RBAC) model to achieve flexible permission allocation and management. The specific steps include: 1. Design three tables of users, roles, and permissions and two intermediate tables of user_roles and role_permissions; 2. Implement permission checking methods in the code such as $user->can('edit_post'); 3. Use cache to improve performance; 4. Use permission control to realize product function layering and differentiated services, thereby supporting membership system and pricing strategies; 5. Avoid the permission granularity is too coarse or too fine, and use "investment"
Explain Laravel Eloquent Scopes.
Jul 26, 2025 am 07:22 AM
Laravel's EloquentScopes is a tool that encapsulates common query logic, divided into local scope and global scope. 1. The local scope is defined with a method starting with scope and needs to be called explicitly, such as Post::published(); 2. The global scope is automatically applied to all queries, often used for soft deletion or multi-tenant systems, and the Scope interface needs to be implemented and registered in the model; 3. The scope can be equipped with parameters, such as filtering articles by year or month, and corresponding parameters are passed in when calling; 4. Pay attention to naming specifications, chain calls, temporary disabling and combination expansion when using to improve code clarity and reusability.
