https://github.com/chandrakantapanda/laravel-sanctum-api-auth
REST API with auth using Laravel 8 and Sanctum Authentication with token Example
https://github.com/chandrakantapanda/laravel-sanctum-api-auth
api-rest laravel laravel-sanctum laravel-sanctum-api-auth-with-token laravel-sanctum-token php restful-api sanctum sanctum-authentication
Last synced: 6 months ago
JSON representation
REST API with auth using Laravel 8 and Sanctum Authentication with token Example
- Host: GitHub
- URL: https://github.com/chandrakantapanda/laravel-sanctum-api-auth
- Owner: chandrakantapanda
- Created: 2023-08-29T05:50:43.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-31T07:47:06.000Z (about 2 years ago)
- Last Synced: 2025-02-03T09:47:43.377Z (8 months ago)
- Topics: api-rest, laravel, laravel-sanctum, laravel-sanctum-api-auth-with-token, laravel-sanctum-token, php, restful-api, sanctum, sanctum-authentication
- Language: PHP
- Homepage:
- Size: 83 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Laravel8 REST API with Sanctum
This is an example of a REST API using auth tokens with Laravel Sanctum
### You have to just follow a few steps to get following web services
##### Login API
##### Product API
## Getting Started
### Step 1: setup database in .env file
````
composer create-project laravel/laravel laravel-sanctum-api
````
### Step 2: setup database in .env file
````
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=
````
## Step 3:Create a schema for product table.
````javascript
php artisan make:migration create_products_table
````
## Step 4:Create a schema for product table.
````javascript
../database/migrations/create_products_table.php
...
public function up(){
Schema::create('products', function (Blueprint $table) {
$table->id();
$table->string('name');
$table->text('detail');
$table->timestamps();
});
}
````
## Step 5:Run your database migrations.
````javascript
php artisan migrate
````
## Step 6:Add the Sanctum's middleware.
````
../app/Http/Kernel.php
use Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful;
...
protected $middlewareGroups = [
...
'api' => [
EnsureFrontendRequestsAreStateful::class,
'throttle:60,1',
\Illuminate\Routing\Middleware\SubstituteBindings::class,
],
];
...
],
````
## Step 7:Let's create the seeder for the User model
```javascript
php artisan make:seeder UsersTableSeeder
````
## Step 8:Now let's insert as record
```javascript
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Hash;
...
...
DB::table('users')->insert([
'name' => 'John Doe',
'email' => 'john@doe.com',
'password' => Hash::make('password')
]);
````
## Step 9:To seed users table with user
```javascript
php artisan db:seed --class=UsersTableSeeder
````
## Step 10: create a controller
```javascript
php artisan make:controller API/AuthController
php artisan make:controller API/ProductController
````
## Step 11: add these in AuthController and /login route in the routes/api.php file:
```javascript
all(), [
'name' => 'required|string',
'email' => 'required|string|unique:users,email',
'password' => 'required|string',
'c_password' => 'required|same:password',
]);
if($validator->fails()){
$response = [
'success' => false,
'message' => 'Validation Error.',
'data' => $validator->errors(),
];
return response()->json($response, 404);
}
$fields = $request->all();
$user = User::create([
'name' => $fields['name'],
'email' => $fields['email'],
'password' => bcrypt($fields['password'])
]);
$token = $user->createToken('myapptoken')->plainTextToken;
$response = [
'success' => true,
'message' => 'User register successfully.',
'data' => $user,
];
return response()->json($response, 200);
}
function login(Request $request){
$user= User::where('email', $request->email)->first();
if (!$user || !Hash::check($request->password, $user->password)) {
$response = [
'success' => false,
'message' => 'Unauthorised.',
];
return response()->json($response, 404);
}
$result['token'] = $user->createToken('my-app-token')->plainTextToken;
$result['name'] = $user->name;
$result['email'] = $user->email;
$response = [
'success' => true,
'message' => 'User login successfully.',
'data' => $result,
];
return response()->json($response, 200);
}
public function logout(Request $request) {
auth()->user()->tokens()->delete();
$response = [
'success' => true,
'message' => 'User Logged Out.',
'data' => array(),
];
return response()->json($response, 200);
}
}
````
## Step 12: Test with postman, Result will be below
```javascript
{
"user": {
"id": 1,
"name": "John Doe",
"email": "john@doe.com",
"email_verified_at": null,
"created_at": null,
"updated_at": null
},
"token": "AbQzDgXa..."
}
````
## Step 13: add these in ProductController
```javascript
true,
'message' => 'Products retrieved successfully.',
'data' => $products,
];
return response()->json($response, 200);
}
public function store(Request $request) {//dd('asila');
$request->validate([
'name' => 'required',
'detail' => 'required',
'slug' => 'required',
'price' => 'required'
]);
$input = $request->all();
$product = Product::create($input);
$response = [
'success' => true,
'message' => 'Products retrieved successfully.',
'data' => $product,
];
// return Product::create($request->all());
}
public function show($id){
$product = Product::find($id);
if (is_null($product)) {
$response = [
'success' => false,
'message' => 'Product not found.',
'data' => [],
];
return response()->json($response, 404);
}
$response = [
'success' => true,
'message' => 'Product retrieved successfully..',
'data' => $product,
];
return response()->json($response, 200);
}
public function update(Request $request, $id){
$input = $request->all();
$validator = Validator::make($input, [
'name' => 'required',
'detail' => 'required',
'price' => 'required'
]);
if($validator->fails()){
$response = [
'success' => false,
'message' => 'Validation Error.',
'data' => $validator->errors(),
];
return response()->json($response, 404);
}
$product = Product::find($id);
$product->name = $input['name'];
$product->detail = $input['detail'];
$product->price = $input['price'];
$product->update();
$response = [
'success' => true,
'message' => 'Product updatedd successfully..',
'data' => $product,
];
return response()->json($response, 200);
}
public function destroy($id)
{
Product::destroy($id);
$response = [
'success' => true,
'message' => 'Product deleted successfully..',
'data' => [],
];
return response()->json($response, 200);
}
}
````
## Step 14: Make Details API or any other with secure route
```javascript
Route::group(['middleware' => 'auth:sanctum'], function(){
//All secure URL's
});
Route::post("login",[UserController::class,'index']);
````
## Routes with postman
```
# Public
GET /api/products
GET /api/product/:id
POST /api/login
@body: email, password
POST /api/register
@body: name, email, password, c_password
# Protected
POST /api/product
@body: name, slug, description, price
PUT /api/product/:id
@body: name, slug, description, price
DELETE /api/product/:id
POST /api/logout
```
# Make sure in details api we will use following headers as listed bellow if it is procted i.e after login and put/post case
```
'headers' => [
'Accept' => 'application/json',
'Authorization' => 'Bearer '.accesstoknwhichiscreatedafterlogin,
]
```