Tutorial 4: How to Build a Laravel 5.5 JWT-Powered Mobile App Authentication API
Update Feb 8 2018: Upgraded from Laravel 5.4 to 5.5, Fixed Password Reset [See Routes Declaration for Web at Step 3 and .env file update at Step 4]
Please note that this tutorial assumes you have some PHP experience, this tutorial does not explain each line of the code instead it presents you with the code and gives you an overview of what the code does and points out the important parts of the code. I have made the code as simple as possible, if you have any questions, please do not hesitate to leave a comment.
Step 1: Create new project and install jwt-auth (*)
Create Laravel project
laravel new JWTAuthentication
Open composer.json and update the require object to include jwt-auth
Step 2: Add JWT Provider and Facades (*)
Open up config/app.php, find the providers array and add the jwt-auth provider:
Find the aliases array and add the jwt-auth facades:
'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class,
'JWTFactory' => Tymon\JWTAuth\Facades\JWTFactory::class,
We also need to publish the assets for this package. From the command line:
After you run this command you will see a new file in the config folder called jwt.php. This file contains settings for jwt-auth, one of which we need to change right away. We need to generate a secret key, from the command line, run:
php artisan jwt:secret
Register the jwt.auth and jwt.refresh middleware in app/Http/Kernel.php
Step 3: Set Up Routes
Open up routes/api.php.
Open up routes/web.php.
Step 4: Set Up Database
Since we are going to allow users to create their accounts within the application, we will need a table to store all of our users. Thankfully, Laravel already ships with a migration to create a basic users table, so we do not need to manually generate one. The default migration for the users table is located in the database/migrations directory.
We need to add an extra column to the users table. Open up the users migration file located in the migrations folder and update the up function.
The class should implement JWTSubject and include the getJWTIdentifier and getJWTCustomClaims functions.
Add ‘username’ to the $fillable array.
Update .env file
Next, we need to update our database and mail settings, update the .env file
If you are using MAMP be sure to add the unix_socket key with a value of the path that the mysql.sock resides in MAMP. Open config/database.php
And run migration
php artisan migrate
if you get the error below
[Illuminate\Database\QueryException] SQLSTATE: Syntax error or access violation: 1071 Specified key was too long; max key length is 767 bytes (SQL: alter table `users` add unique `users_email_unique`(`email`))
SQLSTATE: Syntax error or access violation: 1071 Specified key was too long; max key length is 767 bytes
Open up Providers/AppServiceProvider.php and update the boot function
Step 5: Register (*)
Create a new controller
php artisan make:controller AuthController
This will create AuthController.php in the app/Http/Controllers directory, paste the code below.
Step 6: Log User In and Out
Step 7: Recover Password
Step 8: Testing
Use Chrome plugin Postman to test.
Register and Verify
Create a POST request to api/register with form-data under Body tab. Make sure to enter a valid email address so you can receive the recover password email.
Create a POST request to api/login with form-data under Body tab.
For both test, you should receive a response similar to the one below
Create a GET request to api/logout.
Create a POST request to api/recover with form-data under Body tab.
Unique Username and Email
Attempt to register with the username and/or email address you used in the previous test.