创建 API 控制器 Laravel 命令

如果你正在为你的 Laravel 应用程序编写 API，你需要创建一个 API 控制器来处理 API 请求。 在这篇文章中，我们将介绍如何使用 Laravel 命令行接口来快速创建 API 控制器。

前置条件

在开始之前，请确保你已经安装了 Laravel，并了解了如何使用 Artisan 命令行接口。

创建 API 控制器

使用以下命令来创建一个新的 API 控制器：

php artisan make:controller APIController --api

此命令将在 app/Http/Controllers 目录下创建一个名为 APIController 的新 PHP 文件。

请注意，--api 选项将使命令生成响应规范的代码。这意味着生成的代码将包含许多默认响应头和状态代码。

添加路由

在 app/Http/routes.php 文件中添加一个新路由，指向你的新 API 控制器：

Route::get('/api', 'APIController@index');

这将创建一个 GET 请求到 /api 的路由，并将其映射到 APIController@index 方法。

在 API 控制器中添加方法

在 app/Http/Controllers/APIController.php 文件中，添加一个名为 index 的新方法：

public function index()
{
    $data = [
        'name' => 'John Doe',
        'email' => 'john.doe@example.com',
        'phone' => '(555) 555-1212',
    ];

    return response()->json($data);
}

此方法返回一个 JSON 响应，其中包含包含一些示例数据的数组。

测试 API

现在，你可以访问 /api 路由，以测试你的新 API 控制器。

可以使用 Postman 或任何其他工具来测试它。 只需将 HTTP 请求发送到 /api，你将得到以下 JSON 响应：

{
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "(555) 555-1212"
}

结论

使用 Laravel 命令行接口和控制器，你可以快速轻松地创建响应规范的 API 控制器，为你的应用程序提供强大稳定的 API。

请访问 Laravel 文档 了解更多相关良好信息。