Laravel 视频教程_laravelapi

在现代Web开发中，API（应用程序接口）已经成为连接前后端以及不同服务之间通信的关键。Laravel作为PHP中的框架之一，提供了强大的工具和优雅的语法来构建高效、可维护的API。通过一个具体的示例，介绍如何使用Laravel构建一个简单的API，并提供多种解决方案。

解决方案

通过创建一个简单的用户管理API来展示Laravel的强大功能。我们将实现以下功能：
– 用户注册
– 用户登录
– 获取用户信息
– 更新用户信息

环境准备

在开始之前，请确保你的开发环境已经安装了以下工具：
– PHP 7.4 或更高版本
– Composer
– MySQL 或其他数据库
– Laravel 8.x

创建Laravel项目

我们需要创建一个新的Laravel项目。打开终端并运行以下命令：

bash
composer create-project --prefer-dist laravel/laravel laravelapi


进入项目目录：

bash
cd laravelapi


数据库配置

编辑 .env 文件，配置数据库连接信息：

env
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravelapi
DB_USERNAME=root
DB_PASSWORD=yourpassword


创建用户模型和迁移

生成用户模型和迁移文件：

bash
php artisan make:model User -m


编辑 database/migrations/xxxx_xx_xx_create_users_table.php 文件，添加必要的字段：

php
public function up()
{
Schema::create('users', function (Blueprint $table) {
$table->id();
$table->string('name');
$table->string('email')->unique();
$table->timestamp('email_verified_at')->nullable();
$table->string('password');
$table->rememberToken();
$table->timestamps();
});
}


运行迁移命令：

bash
php artisan migrate


创建控制器

生成用户控制器：

bash
php artisan make:controller UserController


编辑 app/Http/Controllers/UserController.php 文件，添加以下方法：

用户注册

php
use IlluminateHttpRequest;
use AppModelsUser;</p>

<p>public function register(Request $request)
{
    $validated = $request->validate([
        'name' => 'required|string|max:255',
        'email' => 'required|string|email|max:255|unique:users',
        'password' => 'required|string|min:8',
    ]);</p>

<pre><code>$user = User::create([
    'name' => $validated['name'],
    'email' => $validated['email'],
    'password' => bcrypt($validated['password']),
]);

return response()->json(['message' => 'User registered successfully'], 201);

}

用户登录

php
use IlluminateSupportFacadesAuth;</p>

<p>public function login(Request $request)
{
    $validated = $request->validate([
        'email' => 'required|string|email',
        'password' => 'required|string',
    ]);</p>

<pre><code>if (!Auth::attempt($validated)) {
    return response()->json(['message' => 'Invalid credentials'], 401);
}

$user = Auth::user();
$token = $user->createToken('authToken')->plainTextToken;

return response()->json(['user' => $user, 'token' => $token], 200);

}

获取用户信息

php
public function profile()
{
return response()->json(Auth::user(), 200);
}


更新用户信息

php
public function updateProfile(Request $request)
{
    $validated = $request->validate([
        'name' => 'sometimes|required|string|max:255',
        'email' => 'sometimes|required|string|email|max:255|unique:users,email,' . Auth::id(),
        'password' => 'sometimes|required|string|min:8',
    ]);</p>

<pre><code>$user = Auth::user();

if (isset($validated['name'])) {
    $user->name = $validated['name'];
}
if (isset($validated['email'])) {
    $user->email = $validated['email'];
}
if (isset($validated['password'])) {
    $user->password = bcrypt($validated['password']);
}

$user->save();

return response()->json(['message' => 'User updated successfully'], 200);

}

路由配置

编辑 routes/api.php 文件，添加路由：

php
use AppHttpControllersUserController;</p>

<p>Route::post('/register', [UserController::class, 'register']);
Route::post('/login', [UserController::class, 'login']);</p>

<p>Route::middleware('auth:sanctum')->group(function () {
    Route::get('/profile', [UserController::class, 'profile']);
    Route::put('/profile', [UserController::class, 'updateProfile']);
});

测试API

你可以使用Postman或其他API测试工具来测试这些API端点。例如：

• 注册用户：POST /api/register
• 登录用户：POST /api/login
• 获取用户信息：GET /api/profile
• 更新用户信息：PUT /api/profile

多种解决方案

使用JWT认证

除了使用Laravel Sanctum，你还可以使用JWT（JSON Web Tokens）来进行认证。安装 tymon/jwt-auth 包：

bash
composer require tymon/jwt-auth


发布配置文件：

bash
php artisan vendor:publish --provider="TymonJWTAuthProvidersLaravelServiceProvider"


编辑 config/auth.php 文件，配置JWT认证：

php
'defaults' => [
    'guard' => 'api',
    'passwords' => 'users',
],</p>

<p>'guards' => [
    'api' => [
        'driver' => 'jwt',
        'provider' => 'users',
    ],
],

在 app/Http/Middleware/Authenticate.php 中使用JWT中间件：

php
use TymonJWTAuthFacadesJWTAuth;</p>

<p>public function handle($request, Closure $next, ...$guards)
{
    try {
        $user = JWTAuth::parseToken()->authenticate();
    } catch (Exception $e) {
        if ($e instanceof TymonJWTAuthExceptionsTokenInvalidException){
            return response()->json(['status' => 'Token is Invalid'], 401);
        } else if ($e instanceof TymonJWTAuthExceptionsTokenExpiredException){
            return response()->json(['status' => 'Token is Expired'], 401);
        } else {
            return response()->json(['status' => 'Authorization Token not found'], 401);
        }
    }</p>

<pre><code>return $next($request);

}

使用API资源

为了更好地格式化API响应，可以使用Laravel的API资源。生成一个用户资源：

bash
php artisan make:resource UserResource


编辑 app/Http/Resources/UserResource.php 文件：

php
use IlluminateHttpResourcesJsonJsonResource;</p>

<p>class UserResource extends JsonResource
{
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'created<em>at' => $this->created</em>at,
            'updated<em>at' => $this->updated</em>at,
        ];
    }
}

在控制器中使用资源：

php
use AppHttpResourcesUserResource;</p>

<p>public function profile()
{
    return new UserResource(Auth::user());
}

通过以上步骤，你已经成功地创建了一个简单的用户管理API。希望这篇对你有所帮助！