Laravel API Boilerplate is a starting point for your first API.
It is built on top of:
- Laravel Framework - laravel/laravel
- Laravel Passport - laravel/passport
- Laravel-CORS barryvdh/laravel-cors
-
run
composer create-project usamamuneerchaudhary/laravel-api-boilerplate myfirstApi
; -
Rename
.env.example
to.env
-
Generate Passport encryption keys & secret access tokens
php artisan passport:install
-
Generate application key by
php artisan key:generate
-
After DB Connection, run
php artisan migrate
. For dummy data for users, runphp artisan migrate --seed
. You can see more info indatabase\seeds\UserTableSeeder.php
. -
For Testing Emails, you can setup MailTrap.
-
Well that's it lad, it would be up and running on your server already.
- PHP
v7.3
or greater.
You can find Authentication Controllers under namespace App\Http\Controllers\API\Auth
.
There are also the validation rules for every action (login, sign up, recovery and reset) under namespace App\Http \Request\API\Auth
.
- Login:
POST api/v1/login
- Register:
POST api/v1/register
- Recover
POST api/v1/recover
- Reset
POST api/v1/reset
- Find Reset Token
GET api/v1/reset/{token}
- Logout
GET api/v1/logout
- Verify Email
api/v1/user/verify/email/{token}
Please note that, api routes are prefixed with v1
, you can changed this in App\Providers\RouteServiceProvider.php
All the API routes can be found in the routes/api.php
file.
We're using akaunting/firewall to secure our API.
Simpler way of assigning Roles & Permissions to Users. You can more details on what we've done here on usamamuneerchaudhary/roles-permissions
A Simple CRUD Scaffolding package is being setup out of the box to keep you going without any hassle.
You can create your endpoints in routes/api.php
under auth:api
middleware group.
If you want to enable CORS for a specific route or routes group, you just have to use the cors middleware on them.
Thanks to the barryvdh/laravel-cors package, you can handle CORS easily. Just check the docs at this page for more info.
This project is open-sourced software licensed under the MIT license.