第一步：設置 Laravel 項目

首先，通過 Composer 創建一個新的 Laravel 項目：

composer create-project --prefer-dist laravel/laravel rest-api-crud

第二步：配置 MySQL 數據庫

Laravel 11 默認使用 sqlite 作為數據庫連接類型。要切換到 MySQL，請在 .env 文件中將 DB_CONNECTION 修改為 mysql：

DB_CONNECTION=mysql

第三步：使用遷移創建產品模型

運行以下命令，為產品模型創建遷移文件、工廠、控制器等：

php artisan make:model Product -a

第四步：更新遷移文件

打開生成的遷移文件 database/migrations/YYYY_MM_DD_HHMMSS_create_products_table.php，在 up 方法中定義表結構：

public function up(): void
{
    Schema::create('products', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('details');
        $table->timestamps();
    });
}

然后運行遷移命令：

php artisan migrate

第五步：創建產品存儲庫接口

為產品模型創建存儲庫接口，以實現代碼的模塊化和可維護性：

php artisan make:interface Interfaces/ProductRepositoryInterface

在 app/Interfaces 目錄下創建 ProductRepositoryInterface.php 文件，并添加以下代碼：

<?php

namespace AppInterfaces;interface ProductRepositoryInterface
{
    public function index();
    public function getById($id);
    public function store(array $data);
    public function update(array $data, $id);
    public function delete($id);
}

第六步：創建產品存儲庫類

為產品模型創建存儲庫類：

php artisan make:class Repositories/ProductRepository

在 app/Repositories 目錄下創建 ProductRepository.php 文件，并實現接口中的方法。

第七步：綁定接口與實現

將 ProductRepository 綁定到 ProductRepositoryInterface，以便依賴注入。使用以下命令創建服務提供者：

php artisan make:provider RepositoryServiceProvider

打開 app/Providers/RepositoryServiceProvider.php 文件，在 register 方法中添加以下代碼：

public function register()
{
    $this->app->bind(
        AppInterfacesProductRepositoryInterface::class,
        AppRepositoriesProductRepository::class
    );
}

第八步：請求驗證

創建兩個請求類 StoreProductRequest 和 UpdateProductRequest，用于驗證傳入的數據。可以使用以下命令生成：

php artisan make:request StoreProductRequest
php artisan make:request UpdateProductRequest

在生成的請求類中定義驗證規則。

第九步：創建通用 ApiResponse 類

為了統一 API 響應格式，可以創建一個通用的 ApiResponse 類：

php artisan make:class Classes/ApiResponseClass

在 app/Classes 目錄下創建 ApiResponseClass.php 文件，并定義通用響應方法。

第十步：創建產品資源

使用以下命令創建資源類：

php artisan make:resource ProductResource

在資源類中定義數據格式化邏輯，以便統一返回的 JSON 數據結構。

第十一步：創建產品控制器

在控制器中使用存儲庫實現 CRUD 操作。打開 app/Http/Controllers/ProductController.php 文件，添加以下代碼以實現控制器邏輯。

第十二步：定義 API 路由

運行以下命令發布 API 路由文件：

php artisan install:api

然后在 routes/[api](http://m.dlbhg.com/wiki/api/).php 文件中定義路由，將控制器方法映射到相應的路由。例如：

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

總結

通過以上步驟，您可以在 Laravel 11 中構建一個功能完善的 代碼的可維護性和擴展性。

完成所有步驟后，運行以下命令啟動開發服務器并測試 API：

php artisan serve

希望這篇指南對您有所幫助！

原文鏈接: https://medium.com/@1415sandalanka/laravel-11-rest-api-crud-with-best-practices-fcc26505e0d2