Laravel 7/6 REST API with Passport Tutorial

https://www.itsolutionstuff.com/post/laravel-6-rest-api-with-passport-tutorialexample.html

Laravel 7/6 REST API with Passport Tutorial

By Hardik Savani October 12, 2019 Category : LaravelPauseUnmuteLoaded: 5.86%FullscreenHi Developer,

Here, i will tech you how to create rest api with authentication using passport in laravel 7/6 application. i will show you step by step build restful api authentication using eloquent api resources in laravel 7/6. you can easily learn rest api for crud module with authentication in laravel 7/6.

Rest API is must be use when you are working with mobile application. when your application is prefer for web app and mobile app than you must have to create api for your mobile development.

However, Laravel provide easy way to create api. if you have authentication in your mobile app than you can easily do it using passport. Laravel 6 Passport provide way to create auth token for validating users.

So you also want to create rest api for your mobile application than you can follow this tutorial for how to create rest api step by step with laravel 6. If you are new than don't worry about that i written tutorial step by step.

Follow bellow few steps to create restful api example in laravel 6 app.

Step 1: Install Laravel 6

I am going to explain step by step from scratch so, we need to get fresh Laravel 6 application using bellow command, So open your terminal OR command prompt and run bellow command:

composer create-project --prefer-dist laravel/laravel blog

Step 2: Use Passport

In this step we need to install passport via the Composer package manager, so one your terminal and fire bellow command:

composer require laravel/passport

After successfully install package, we require to get default migration for create new passport tables in our database. so let's run bellow command.

php artisan migrate

Next, we need to install passport using command, Using passport:install command, it will create token keys for security. So let's run bellow command:

php artisan passport:install

Read Also: Laravel 6 CRUD Application Tutorial

Step 3: Passport Configuration

In this step, we have to configuration on three place model, service provider and auth config file. So you have to just following change on that file.

In model we added HasApiTokens class of Passport,

In AuthServiceProvider we added "Passport::routes()",

In auth.php, we added api auth configuration.

app/User.php

<?php  namespace App;  use Illuminate\Notifications\Notifiable;use Illuminate\Contracts\Auth\MustVerifyEmail;use Laravel\Passport\HasApiTokens;use Illuminate\Foundation\Auth\User as Authenticatable;  class User extends Authenticatable implements MustVerifyEmail{    use HasApiTokens, Notifiable;      /**     * The attributes that are mass assignable.     *     * @var array     */    protected $fillable = [        'name', 'email', 'password',    ];      /**     * The attributes that should be hidden for arrays.     *     * @var array     */    protected $hidden = [        'password', 'remember_token',    ];}

app/Providers/AuthServiceProvider.php

<?phpnamespace App\Providers;use Laravel\Passport\Passport;use Illuminate\Support\Facades\Gate;use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;class AuthServiceProvider extends ServiceProvider{    /**     * The policy mappings for the application.     *     * @var array     */    protected $policies = [        'App\Model' => 'App\Policies\ModelPolicy',    ];    /**     * Register any authentication / authorization services.     *     * @return void     */    public function boot()    {        $this->registerPolicies();    }}

config/auth.php

<?phpreturn [    .....    'guards' => [        'web' => [            'driver' => 'session',            'provider' => 'users',        ],        'api' => [            'driver' => 'passport',            'provider' => 'users',        ],    ],    .....]

Step 4: Add Product Table and Model

next, we require to create migration for posts table using Laravel 6 php artisan command, so first fire bellow command:

php artisan make:migration create_products_table

After this command you will find one file in following path database/migrations and you have to put bellow code in your migration file for create products table.

<?phpuse Illuminate\Support\Facades\Schema;use Illuminate\Database\Schema\Blueprint;use Illuminate\Database\Migrations\Migration;class CreateProductsTable extends Migration{    /**     * Run the migrations.     *     * @return void     */    public function up()    {        Schema::create('products', function (Blueprint $table) {            $table->bigIncrements('id');            $table->string('name');            $table->text('detail');            $table->timestamps();        });    }    /**     * Reverse the migrations.     *     * @return void     */    public function down()    {        Schema::dropIfExists('products');    }}

After create migration we need to run above migration by following command:

php artisan migrate

After create "products" table you should create Product model for products, so first create file in this path app/Product.php and put bellow content in item.php file:

app/Product.php

<?php  namespace App;   use Illuminate\Database\Eloquent\Model;   class Product extends Model{    /**     * The attributes that are mass assignable.     *     * @var array     */    protected $fillable = [        'name', 'detail'    ];}

Step 5: Create API Routes

In this step, we will create api routes. Laravel provide api.php file for write web services route. So, let's add new route on that file.

routes/api.php

<?php  /*|--------------------------------------------------------------------------| API Routes|--------------------------------------------------------------------------|| Here is where you can register API routes for your application. These| routes are loaded by the RouteServiceProvider within a group which| is assigned the "api" middleware group. Enjoy building your API!|*/  Route::post('register', 'API\RegisterController@register');Route::post('login', 'API\RegisterController@login');   Route::middleware('auth:api')->group( function () {    Route::resource('products', 'API\ProductController');});

Step 6: Create Controller Files

in next step, now we have create new controller as BaseController, ProductController and RegisterController, i created new folder "API" in Controllers folder because we will make alone APIs controller, So let's create both controller:

app/Http/Controllers/API/BaseController.php

<?phpnamespace App\Http\Controllers\API;use Illuminate\Http\Request;use App\Http\Controllers\Controller as Controller;class BaseController extends Controller{    /**     * success response method.     *     * @return \Illuminate\Http\Response     */    public function sendResponse($result, $message)    {    	$response = [            'success' => true,            'data'    => $result,            'message' => $message,        ];        return response()->json($response, 200);    }    /**     * return error response.     *     * @return \Illuminate\Http\Response     */    public function sendError($error, $errorMessages = [], $code = 404)    {    	$response = [            'success' => false,            'message' => $error,        ];        if(!empty($errorMessages)){            $response['data'] = $errorMessages;        }        return response()->json($response, $code);    }}

app/Http/Controllers/API/RegisterController.php

<?php   namespace App\Http\Controllers\API;   use Illuminate\Http\Request;use App\Http\Controllers\API\BaseController as BaseController;use App\User;use Illuminate\Support\Facades\Auth;use Validator;   class RegisterController extends BaseController{    /**     * Register api     *     * @return \Illuminate\Http\Response     */    public function register(Request $request)    {        $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')->accessToken;        $success['name'] =  $user->name;           return $this->sendResponse($success, 'User register successfully.');    }       /**     * Login api     *     * @return \Illuminate\Http\Response     */    public function login(Request $request)    {        if(Auth::attempt(['email' => $request->email, 'password' => $request->password])){             $user = Auth::user();             $success['token'] =  $user->createToken('MyApp')-> accessToken;             $success['name'] =  $user->name;               return $this->sendResponse($success, 'User login successfully.');        }         else{             return $this->sendError('Unauthorised.', ['error'=>'Unauthorised']);        }     }}

app/Http/Controllers/API/ProductController.php

<?php   namespace App\Http\Controllers\API;   use Illuminate\Http\Request;use App\Http\Controllers\API\BaseController as BaseController;use App\Product;use Validator;use App\Http\Resources\Product as ProductResource;   class ProductController extends BaseController{    /**     * Display a listing of the resource.     *     * @return \Illuminate\Http\Response     */    public function index()    {        $products = Product::all();            return $this->sendResponse(ProductResource::collection($products), 'Products retrieved successfully.');    }    /**     * Store a newly created resource in storage.     *     * @param  \Illuminate\Http\Request  $request     * @return \Illuminate\Http\Response     */    public function store(Request $request)    {        $input = $request->all();           $validator = Validator::make($input, [            'name' => 'required',            'detail' => 'required'        ]);           if($validator->fails()){            return $this->sendError('Validation Error.', $validator->errors());               }           $product = Product::create($input);           return $this->sendResponse(new ProductResource($product), 'Product created successfully.');    }        /**     * Display the specified resource.     *     * @param  int  $id     * @return \Illuminate\Http\Response     */    public function show($id)    {        $product = Product::find($id);          if (is_null($product)) {            return $this->sendError('Product not found.');        }           return $this->sendResponse(new ProductResource($product), 'Product retrieved successfully.');    }        /**     * Update the specified resource in storage.     *     * @param  \Illuminate\Http\Request  $request     * @param  int  $id     * @return \Illuminate\Http\Response     */    public function update(Request $request, Product $product)    {        $input = $request->all();           $validator = Validator::make($input, [            'name' => 'required',            'detail' => 'required'        ]);           if($validator->fails()){            return $this->sendError('Validation Error.', $validator->errors());               }           $product->name = $input['name'];        $product->detail = $input['detail'];        $product->save();           return $this->sendResponse(new ProductResource($product), 'Product updated successfully.');    }       /**     * Remove the specified resource from storage.     *     * @param  int  $id     * @return \Illuminate\Http\Response     */    public function destroy(Product $product)    {        $product->delete();           return $this->sendResponse([], 'Product deleted successfully.');    }}

Step 7: Create Eloquent API Resources

This is a very important step of creating rest api in laravel 6. you can use eloquent api resources with api. it will helps you to make same response layout of your model object. we used in ProductController file. now we have to create it using following command:

php artisan make:resource Product

Now there created new file with new folder on following path:

app/Http/Resources/Product.php

<?php  namespace App\Http\Resources;   use Illuminate\Http\Resources\Json\JsonResource;   class Product extends JsonResource{    /**     * Transform the resource into an array.     *     * @param  \Illuminate\Http\Request  $request     * @return array     */    public function toArray($request)    {        return [            'id' => $this->id,            'name' => $this->name,            'detail' => $this->detail,            'created_at' => $this->created_at->format('d/m/Y'),            'updated_at' => $this->updated_at->format('d/m/Y'),        ];    }}

Now we are ready to to run full restful api and also passport api in laravel. so let's run our example so run bellow command for quick run:

php artisan serve

make sure in details api we will use following headers as listed bellow:

Read Also: Laravel 7/6 Multi Auth (Authentication) Tutorial

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

Here is Routes URL with Verb:

Now simply you can run above listed url like as bellow screen shot:

1) Register API: Verb:GET, URL:http://localhost:8000/api/register

2) Login API: Verb:GET, URL:http://localhost:8000/api/login

3) Product List API: Verb:GET, URL:http://localhost:8000/api/products

4) Product Create API: Verb:POST, URL:http://localhost:8000/api/products

5) Product Show API: Verb:GET, URL:http://localhost:8000/api/products/{id}

6) Product Update API: Verb:PUT, URL:http://localhost:8000/api/products/{id}

7) Product Delete API: Verb:DELETE, URL:http://localhost:8000/api/products/{id}

You can download code from git: Download Code from Github

I hope it can help you...