Laravel REST api

Steps to create REST API in laravel

1. Add a column to users table named token_key
2. Go to app\Http\Controllers\Auth\RegisterController.php and inside create function add a column named token_key = str_random(60),
3. Create a ApiController with –resource for the API
4. Create Route::group([‘prefix’ => ‘api’, ‘middleware’ => ‘auth:api’], function() {…….})
5. Now add the api_key in model $fillable and/or hidden
6. Set business logic in your ApiController.

Passport

composer require laravel/passport

php artisan migrate

php artisan passport:install

class User extends Authenticatable
{
use HasApiTokens, Notifiable;
}

public function boot()
{
$this->registerPolicies();
Passport::routes();
}

'web' => [
// Other middleware...
\Laravel\Passport\Http\Middleware\CreateFreshApiToken::class,
],

php artisan make:auth
php artisan migrate

protected $except = [
'api/*'
];

Route::get('/token', function(){
     return Auth::user()->createToken('test');
});

factory('App\User')->create()
Default password will be secret

Without passport using api guard

1. Add an api_token
   The first think you need to do is to add an api_token column to your users table. If you are just starting your application you can likely get away with modifying the user migration that ships with Laravel to include your new column.
2. add this to your users_table migration

   $table->string('api_token', 60)->unique();

   Note: Be sure to generate and assign an api_token to new users. Something like str_random(60) should be sufficient.
3. Wrap your routes
   Second, we need to make sure that any routes that will be using Token Authentication are being protected by the auth:api middleware.
   Use the following route group as an example of what your routes might look like.

   Route::group(['prefix' => 'api/v1', 'middleware' => 'auth:api'], function () {
   Route::post('/short', 'UrlMapperController@store');
   });
   

   Note: Typically when protecting routes from unauthenticated users, we use the auth middleware, but by appending :api to the end we are telling Laravel that we want to use the driver for the api guard which is set up in the config/auth.php and is defaulted to token.
   At this point, any routes wrapped with your auth:api middleware are only accessible to those that visit the route with a valid api_token in their request.
4. Getting the User
   To get the authenticated user for this API request, use the following snippet:

   Auth::guard('api')->user();
   

   Just like when we called the middleware, we have to let Laravel know that we want the api guard instead of the default web guard.
Extras
In the App\Http\Middleware\Authenticate middleware, you might want to change the following lines:
Update: This has been merged into 5.2. Check out the current Authenticate Middleware here

// Original
if ($request->ajax()) {
return response('Unauthorized.', 401);
} else {
return redirect()->guest('login');
}
// Updated
if ($request->ajax() || $request->wantsJson()) {
return response('Unauthorized.', 401);
} else {
return redirect()->guest('login');
}

This will return a 401 status code to unauthorized API requests instead of redirect it to a login page.

Labels: Laravel, Web development