Laravel API Boilerplate with OAuth2

This is a boilerplate for Laravel 5.8 if you are using Laravel to write REST api it will help you.

This project use laravel/passport.

Write some easy APIs.

USEFUL LINKS

• Laravel Documentation https://laravel.com/docs/5.8
• Laravel Passport https://laravel.com/docs/5.8/passport
• Rest API Debug Postman

Installation

Install the project

git clone [email protected]:jeylabs/laravel-api-boilerplate
cd api_service

Environment Files

This package ships with a .env.example file in the root of the project. You must rename this file to just .env Note: Make sure you have hidden files shown on your system.

Composer

Laravel project dependencies are managed through the PHP Composer tool. The first step is to install the depencencies by navigating into your project in terminal and typing this command:

composer install

Create Database

You must create your database on your server and on your .env file update the following lines:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=homestead
DB_USERNAME=homestead
DB_PASSWORD=secret

Change these lines to reflect your new database settings.

Artisan Commands

The first thing we are going to so is set the key that Laravel will use when doing encryption.

php artisan key:generate

You should see a green message stating your key was successfully generated. As well as you should see the APP_KEY variable in your .env file reflected.

It's time to see if your database credentials are correct.

We are going to run the built in migrations to create the database tables:

php artisan migrate

You should see a message for each table migrated, if you don't and see errors, than your credentials are most likely not correct.

php artisan db:seed

You should get a message for each file seeded, you should see the information in your database tables.

Next, you should run the passport:install command. This command will create the encryption keys needed to generate secure access tokens. In addition, the command will create "personal access" and "password grant" clients which will be used to generate access tokens:

php artisan passport:install

Next, generate the swagger api documentation

php artisan l5-swagger:generate

Then you can read the document in this URL api/documentation

Available Command

key:generate      Set the application key

make:command      Create a new Artisan command
make:controller   Create a new controller class
make:event        Create a new event class
make:job          Create a new job class
make:listener     Create a new event listener class
make:mail         Create a new email class
make:middleware   Create a new middleware class
make:migration    Create a new migration file
make:model        Create a new Eloquent model class
make:policy       Create a new policy class
make:provider     Create a new service provider class
make:seeder       Create a new seeder class
make:test         Create a new test class

Additional Useful Command

clear-compiled    Remove the compiled class file
serve             Serve the application on the PHP development server
tinker            Interact with your application
optimize          Optimize the framework for better performance
route:list        Display all registered routes.

Installed routes

This boilerplate have following routes after you call routes() method (see instructions below):

Verb	Path	NamedRoute	Controller	Action	Middleware
POST	/oauth/token		\Laravel\Passport\Http\Controllers\AccessTokenController	issueToken	-
GET	/oauth/tokens		\Laravel\Passport\Http\Controllers\AuthorizedAccessTokenController	forUser	auth
DELETE	/oauth/tokens/{token_id}		\Laravel\Passport\Http\Controllers\AuthorizedAccessTokenController	destroy	auth
POST	/oauth/token/refresh		\Laravel\Passport\Http\Controllers\TransientTokenController	refresh	auth
GET	/oauth/clients		\Laravel\Passport\Http\Controllers\ClientController	forUser	auth
POST	/oauth/clients		\Laravel\Passport\Http\Controllers\ClientController	store	auth
PUT	/oauth/clients/{client_id}		\Laravel\Passport\Http\Controllers\ClientController	update	auth
DELETE	/oauth/clients/{client_id}		\Laravel\Passport\Http\Controllers\ClientController	destroy	auth
GET	/oauth/scopes		\Laravel\Passport\Http\Controllers\ScopeController	all	auth
GET	/oauth/personal-access-tokens		\Laravel\Passport\Http\Controllers\PersonalAccessTokenController	forUser	auth
POST	/oauth/personal-access-tokens		\Laravel\Passport\Http\Controllers\PersonalAccessTokenController	store	auth
DELETE	/oauth/personal-access-tokens/{token_id}		\Laravel\Passport\Http\Controllers\PersonalAccessTokenController	destroy	auth

Login

After your project is installed and you can access it in a browser, click the login button on the right of the navigation bar.

The user credentials are:

Username: [email protected] Password: secret

TODO

• phpunit

Tips

Test the project

php artisan serve

Laravel development server will start: http://127.0.0.1:8000

License

MIT license