Laravel怎么在api文件里定义一个GET接口-php教程-PHP中文网

Laravel API GET接口定义在routes/api.php，自动带/api/前缀并使用API中间件；支持闭包、控制器方法、路径/查询参数三种写法，需注意禁用CSRF、统一响应格式及可选版本控制。

laravel怎么在api文件里定义一个get接口

在 Laravel 中，API 的 GET 接口通常定义在 routes/api.php 文件里，它会自动加上 /api/ 前缀，并默认使用 API 中间件（如无状态、CSRF 免除等）。

1. 基础 GET 路由写法

打开 routes/api.php，用 Route::get() 定义接口：

use Illuminate\Http\Request;

Route::get('/users', function (Request $request) {
    return response()->json(['users' => ['Alice', 'Bob']]);
});

访问 http://your-app.test/api/users 就能返回 JSON 数据。

2. 指向控制器方法（推荐）

实际项目中建议把逻辑移到控制器里，先生成控制器：

php artisan make:controller Api/UserController --api

然后在 routes/api.php 中注册：

laravel-specialist

精通 Laravel 10+，遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载

use App\Http\Controllers\Api\UserController;

Route::get('/users', [UserController::class, 'index']);

再在 app/Http/Controllers/Api/UserController.php 中写处理逻辑：

public function index()
{
    return response()->json([
        'data' => User::all(),
        'message' => 'Users fetched successfully'
    ]);
}

3. 带参数的 GET 接口

支持路径参数或查询参数：

路径参数（如 /api/users/123）：

Route::get('/users/{id}', [UserController::class, 'show']);

控制器中接收：

public function show($id)
{
    $user = User::find($id);
    return $user ? response()->json($user) : response()->json(['error' => 'Not found'], 404);
}

查询参数（如 /api/users?role=admin）：

public function index(Request $request)
{
    $users = User::when($request->role, function ($query, $role) {
        return $query->where('role', $role);
    })->get();
    return response()->json($users);
}

4. 注意事项

不要加 CSRF 防护：API 路由默认不启用 VerifyCsrfToken，确保中间件组是 api（routes/api.php 默认已配置）
响应统一格式：可配合资源类（php artisan make:resource UserResource）规范输出结构
版本控制可选：如需多版本，可写成 Route::prefix('v1')->group(...)