安裝 Laravel 并啟動開發(fā)服務器

在開始之前，確保您已經(jīng)安裝了 Laravel。安裝完成后，使用以下命令啟動開發(fā)服務器：

php artisan serve

運行該命令后，導航到您的項目目錄，即可啟動 Laravel 的開發(fā)服務器。

創(chuàng)建新的控制器

Laravel 中的控制器負責處理傳入的請求并生成相應的響應。要為 API 端點創(chuàng)建一個新的控制器，可以使用 Artisan 提供的 make:controller 命令：

php artisan make:controller ApiController

運行此命令后，Laravel 會在 app/Http/Controllers 目錄下生成一個名為 ApiController.php 的新控制器文件。

定義 API 路由

在 Laravel 中，路由是處理傳入請求的入口點。要為新的 API 端點定義路由，請打開 routes/api.php 文件，并添加以下代碼：

Route::get('/endpoint', [ApiController::class, 'methodName']);

在上述代碼中：

• 將 /endpoint 替換為您希望的端點 URL。
• 將 methodName 替換為您在 ApiController 中定義的具體方法名稱。

在控制器中定義方法

接下來，打開 app/Http/Controllers/ApiController.php 文件，并定義與路由中指定的端點相對應的方法。例如：

public function methodName()
{
    return response()->json([
        'message' => '你好，世界！'
    ], 200);
}

在這里：

• methodName 是您在路由中指定的方法名稱。
• response()->json() 用于返回 JSON 格式的響應數(shù)據(jù)。
• 將 '你好，世界！' 替換為您希望返回的實際數(shù)據(jù)。

測試 API 端點

完成控制器和路由的設置后，您可以使用 Postman 或 curl 等工具測試新的 API 端點。例如，發(fā)送請求到以下 URL（默認情況下）：

http://localhost:8000/api/endpoint

如果一切設置正確，您將收到在控制器方法中定義的 JSON 響應。

總結

在 Laravel 中創(chuàng)建新的 API 端點是每個 Web 開發(fā)者都需要掌握的基本技能。通過本文的步驟，您可以輕松完成端點的配置、邏輯設計以及功能測試。隨著對 Laravel 的深入學習，您還可以探索更多高級功能和技術，構建更強大、更高效的 API。

祝您編碼愉快！

原文鏈接: https://medium.com/@theresalisseau2001/a-beginners-guide-creating-a-new-api-endpoint-in-laravel-f96cd8455c90