創(chuàng)建Laravel項(xiàng)目並配置數(shù)據(jù)庫(kù)環(huán)境；2. 使用Artisan生成模型、遷移和控制器；3. 在api.php中定義API資源路由；4. 實(shí)現(xiàn)控制器中的增刪改查方法並使用請(qǐng)求驗(yàn)證；5. 安裝Laravel Sanctum實(shí)現(xiàn)API認(rèn)證並保護(hù)路由；6. 統(tǒng)一JSON響應(yīng)格式並處理錯(cuò)誤；7. 使用Postman等工具測(cè)試API，最終得到一個(gè)功能完整、可擴(kuò)展的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

• -m creates a migration
• -c creates a controller
• -r adds 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 require 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() or load() .
• 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.

以上是如何與Laravel創(chuàng)建一個(gè)寧?kù)o的API？的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！