Utwórz uwierzytelnianie REST API w LARAVEL 9 USING LARAVEL SANCTUM
Laravel Sanctum zapewnia system uwierzytelniania piórkowego dla SPA (aplikacji jednostronicowych), aplikacji mobilnych i prostych interfejsów API opartych na tokenach.
Kroki
instalacji Jeśli nie używasz LARAVEL 9, musisz zainstalować LARAVEL Sanctum W przeciwnym razie możesz pominąć krok instalacji.
Krok 1
Zainstaluj przez kompozytor
composer require laravel/sanctum
Krok 2
Opublikuj dostawcę usług Sanctum
php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"
Krok 3
Migracja bazy danych
php artisan migrate
UŻYWANIE SANCTUM W LARAVEL
Cecha użytkownika w Aby korzystać z Sanctum, musimy użyć HasApiTokens
klasy cechy w App\Models\User
modelu użytkownikaHasApiTokens
.
Model użytkownika powinien wyglądać tak.
<?php
namespace App\Models;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;
class User extends Authenticatable
{
use HasApiTokens, HasFactory, Notifiable;
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'name',
'email',
'password',
];
/**
* The attributes that should be hidden for serialization.
*
* @var array<int, string>
*/
protected $hidden = [
'password',
'remember_token',
];
/**
* The attributes that should be cast.
*
* @var array<string, string>
*/
protected $casts = [
'email_verified_at' => 'datetime',
];
}
Trasy
uwierzytelniania interfejsu API Utwórz AuthController
w celu obsługi wszystkich uwierzytelnień przekazywanych do interfejsu API
php artisan make:controller Api\\AuthController
W routes\api.php
pliku zaktualizuj interfejs API
Route::post('/auth/register', [AuthController::class, 'createUser']);
Route::post('/auth/login', [AuthController::class, 'loginUser']);
Teraz aktualizuj za AuthContoller
pomocą
<?php
namespace App\Http\Controllers\Api;
use App\Models\User;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Facades\Validator;
class AuthController extends Controller
{
/**
* Create User
* @param Request $request
* @return User
*/
public function createUser(Request $request)
{
try {
//Validated
$validateUser = Validator::make($request->all(),
[
'name' => 'required',
'email' => 'required|email|unique:users,email',
'password' => 'required'
]);
if($validateUser->fails()){
return response()->json([
'status' => false,
'message' => 'validation error',
'errors' => $validateUser->errors()
], 401);
}
$user = User::create([
'name' => $request->name,
'email' => $request->email,
'password' => Hash::make($request->password)
]);
return response()->json([
'status' => true,
'message' => 'User Created Successfully',
'token' => $user->createToken("API TOKEN")->plainTextToken
], 200);
} catch (\Throwable $th) {
return response()->json([
'status' => false,
'message' => $th->getMessage()
], 500);
}
}
/**
* Login The User
* @param Request $request
* @return User
*/
public function loginUser(Request $request)
{
try {
$validateUser = Validator::make($request->all(),
[
'email' => 'required|email',
'password' => 'required'
]);
if($validateUser->fails()){
return response()->json([
'status' => false,
'message' => 'validation error',
'errors' => $validateUser->errors()
], 401);
}
if(!Auth::attempt($request->only(['email', 'password']))){
return response()->json([
'status' => false,
'message' => 'Email & Password does not match with our record.',
], 401);
}
$user = User::where('email', $request->email)->first();
return response()->json([
'status' => true,
'message' => 'User Logged In Successfully',
'token' => $user->createToken("API TOKEN")->plainTextToken
], 200);
} catch (\Throwable $th) {
return response()->json([
'status' => false,
'message' => $th->getMessage()
], 500);
}
}
}
Protect API Za pomocą uwierzytelniania musimy używać auth:sanctum
oprogramowania pośredniczącego.
Route::apiResource('posts', PostController::class)->middleware('auth:sanctum');
Oto wyniki.
Pełny samouczek znajduje się poniżej w filmie.
Dziękujemy za przeczytanie