Laravel API Boilerplate (Passport Edition)

Laravel API Boilerplate is a "starter kit" you can use to build your first API in seconds. As you can easily imagine, it is built on top of the awesome Laravel Framework. This version is built on Laravel 5.8!

This Boilerplate supports OAuth2 password grant out of the box which allows your other first-party clients, such as a mobile application, to obtain an access token using an e-mail address and password. But feel free to use other grant types in laravel/passport by extending this.

It is built on top of these big guys:

Laravel Passport - laravel/passport
Dingo API - dingo/api
Laravel-CORS barryvdh/laravel-cors

What I made is really simple: an integration of these three packages and a setup of some authentication and credentials recovery methods.

Installation

run composer create-project pktharindu/laravel-api-boilerplate-passport newProject;
have a coffee, nothing to do here;

Once the project creation procedure will be completed, run the php artisan migrate command to install the required tables.

Then, run the php artisan passport:client --password command to create a password grant client to issue access tokens securely to your first-party clients.

Main Features

Ready-To-Use Authentication Controllers

You don't have to worry about authentication and password recovery anymore. I created four controllers you can find in the App\Api\V1\Controllers for those operations.

For each controller there's an already setup route in routes/api.php file:

POST api/auth/login, to do the login and get your access token or to refresh your existent token;
POST api/auth/register, to create a new user into your application;
POST api/auth/recovery, to recover your credentials;
POST api/auth/reset, to reset your password after the recovery;
POST api/auth/logout, to log out the user by invalidating the passed token;

Separate File for Routes

All the API routes can be found in the routes/api.php file. This also follow the Laravel convention.

Secrets Generation

Every time you create a new project starting from this repository, the php artisan passport:keys command will be executed.

Configuration

As I already said before, this boilerplate is based on laravel/passport and dingo/api packages. So, you can find many information about configuration here and here.

There are also the validation rules for every action (login, sign up, recovery and reset) inside app/Api/V1/Requests directory. Feel free to customize them for your needs.

Creating Endpoints

You can create endpoints in the same way you could to with using the single dingo/api package. You can read its documentation for details. After all, this is just a boilerplate! 😏

However, I added some example routes to the routes/api.php file to give you immediately an idea.

Cross Origin Resource Sharing

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.

Code styling

PHP-CS-Fixer is used for strong 💪 style guidelines.

PHP is pre-configured for official Laravel styling, just launch vendor\bin\php-cs-fixer fix for global project auto-formatting.

Tests

If you want to contribute to this project, feel free to do it and open a PR. However, make sure you have tests for what you implement.

In order to run tests:

run vendor\bin\phpunit;

Feedback

I made this project for personal purposes. I decided to share it here to help anyone with the same needs 😇. If you have any feedback to improve it, feel free to make a suggestion, or open a PR!

License

This project is open-sourced software licensed under the MIT license.

pktharindu/laravel-api-boilerplate-passport