Laravel 11 – Building API using Sanctum

composer create-project laravel/laravel sanctum-api

cd sanctum-api

php artisan install:api

<?php

namespace AppModels;

// use IlluminateContractsAuthMustVerifyEmail;
use IlluminateDatabaseEloquentFactoriesHasFactory;
use IlluminateFoundationAuthUser as Authenticatable;
use IlluminateNotificationsNotifiable;
use LaravelSanctumHasApiTokens;

class User extends Authenticatable
{
use HasFactory, Notifiable, HasApiTokens;

/**
* 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’,
];

/**
* Get the attributes that should be cast.
*
* @return array<string, string>
*/
protected function casts(): array
{
return [
’email_verified_at’ => ‘datetime’,
‘password’ => ‘hashed’,
];
}
}

php artisan make:model Blog -m

<?php

use IlluminateDatabaseMigrationsMigration;
use IlluminateDatabaseSchemaBlueprint;
use IlluminateSupportFacadesSchema;

return new class extends Migration
{
/**
* Run the migrations.
*/
public function up(): void
{
Schema::create(‘blogs’, function (Blueprint $table) {
$table->id();
$table->string(‘title’);
$table->longText(‘detail’);
$table->timestamps();
});
}

/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::dropIfExists(‘blogs’);
}
};

<?php

namespace AppModels;

use IlluminateDatabaseEloquentFactoriesHasFactory;
use IlluminateDatabaseEloquentModel;

class Blog extends Model
{
use HasFactory;

protected $fillable = [
‘title’, ‘detail’
];
}

php artisan make:resource BlogResource

<?php

namespace AppHttpResources;

use IlluminateHttpRequest;
use IlluminateHttpResourcesJsonJsonResource;

class BlogResource extends JsonResource
{
// Transform the resource into an array.
public function toArray(Request $request): array
{
return [
‘id’ => $this->id,
‘title’ => $this->title,
‘detail’ => $this->detail,
‘created_at’ => $this->created_at->format(‘d/m/Y’),
‘updated_at’ => $this->updated_at->format(‘d/m/Y’),
];
}
}

php artisan make:controller API/BaseController
php artisan make:controller API/RegisterController
php artisan make:controller API/BlogController

<?php

namespace AppHttpControllersAPI;

use AppHttpControllersController;
use IlluminateHttpRequest;

class BaseController extends Controller
{
// success response method
public function sendResponse($result, $message)
{
$response = [
‘success’ => true,
‘data’ => $result,
‘message’ => $message,
];

return response()->json($response, 200);
}

// return error response
public function sendError($error, $errorMessages = [], $code = 404)
{
$response = [
‘success’ => false,
‘message’ => $error,
];

if(!empty($errorMessages)){
$response[‘data’] = $errorMessages;
}

return response()->json($response, $code);
}
}

<?php

namespace AppHttpControllersAPI;

use AppHttpControllersController;
use IlluminateHttpRequest;
use AppModelsUser;
use IlluminateSupportFacadesAuth;
use IlluminateHttpJsonResponse;
use IlluminateSupportFacadesValidator;

class RegisterController extends BaseController
{
// Register api
public function register(Request $request): JsonResponse
{
$validator = Validator::make($request->all(), [
‘name’ => ‘required’,
’email’ => ‘required|email’,
‘password’ => ‘required’,
‘c_password’ => ‘required|same:password’,
]);

if($validator->fails()){
return $this->sendError(‘Validation Error.’, $validator->errors());
}

$input = $request->all();
$input[‘password’] = bcrypt($input[‘password’]);
$user = User::create($input);
$success[‘token’] = $user->createToken(‘MyApp’)->plainTextToken;
$success[‘name’] = $user->name;

return $this->sendResponse($success, ‘User register successfully.’);
}

// Login api
public function login(Request $request): JsonResponse
{
if(Auth::attempt([’email’ => $request->email, ‘password’ => $request->password])){
$user = Auth::user();
$success[‘token’] = $user->createToken(‘MyApp’)->plainTextToken;
$success[‘name’] = $user->name;

return $this->sendResponse($success, ‘User login successfully.’);
}
else{
return $this->sendError(‘Unauthorised.’, [‘error’=>‘Unauthorised’]);
}
}
}

<?php

namespace AppHttpControllersAPI;

use AppHttpControllersController;
use IlluminateHttpRequest;
use AppHttpControllersAPIBaseController;
use AppModelsBlog;
use AppHttpResourcesBlogResource;
use IlluminateHttpJsonResponse;
use IlluminateSupportFacadesValidator;

class BlogController extends BaseController
{
// Display a listing of the resource.
public function index(): JsonResponse
{
$blogs = Blog::all();

return $this->sendResponse(BlogResource::collection($blogs), ‘Blogs retrieved successfully.’);
}

// Store a newly created resource in storage.
public function store(Request $request): JsonResponse
{
$input = $request->all();

$validator = Validator::make($input, [
‘title’ => ‘required’,
‘detail’ => ‘required’
]);

if($validator->fails()){
return $this->sendError(‘Validation Error.’, $validator->errors());
}

$blog = Blog::create($input);

return $this->sendResponse(new BlogResource($blog), ‘Blog created successfully.’);
}

// Display the specified resource.
public function show($id): JsonResponse
{
$blog = Blog::find($id);

if (is_null($blog)) {
return $this->sendError(‘Blog not found.’);
}

return $this->sendResponse(new BlogResource($blog), ‘Blog retrieved successfully.’);
}

// Update the specified resource in storage.
public function update(Request $request, Blog $blog): JsonResponse
{
$input = $request->all();

$validator = Validator::make($input, [
‘title’ => ‘required’,
‘detail’ => ‘required’
]);

if($validator->fails()){
return $this->sendError(‘Validation Error.’, $validator->errors());
}

$blog->title = $input[‘title’];
$blog->detail = $input[‘detail’];
$blog->save();

return $this->sendResponse(new BlogResource($blog), ‘Blog updated successfully.’);
}

// Remove the specified resource from storage.
public function destroy(Blog $blog): JsonResponse
{
$blog->delete();

return $this->sendResponse([], ‘Blog deleted successfully.’);
}
}

<?php

use IlluminateHttpRequest;
use IlluminateSupportFacadesRoute;
use AppHttpControllersAPIRegisterController;
use AppHttpControllersAPIBlogController;

Route::controller(RegisterController::class)->group(function(){
Route::post(‘register’, ‘register’)->name(‘register’);
Route::post(‘login’, ‘login’)->name(‘login’);
});

Route::middleware(‘auth:sanctum’)->group( function () {
Route::apiResource(‘blogs’, BlogController::class);
Route::get(‘user’, function (Request $request) {
return $request->user();
})->name(‘user’);
});

php artisan serve

php artisan serve

‘headers’ => [
‘Accept’ => ‘application/json’,
‘Authorization’ => ‘Bearer ‘.$accessToken,
]