kennethtomagan/laravel-6-api-boilerplate

A Laravel 6 API Boilerplate to create a ready-to-use REST API. User Authentication using JWT.

6.0 2019-10-03 00:29 UTC

Requires

• php: ^7.2
• barryvdh/laravel-cors: ^0.11.4
• fideloper/proxy: ^4.0
• laravel/framework: ^6.0
• laravel/tinker: ^1.0
• tymon/jwt-auth: 1.0.0-rc.5

Requires (Dev)

• facade/ignition: ^1.4
• fzaninotto/faker: ^1.4
• mockery/mockery: ^1.0
• nunomaduro/collision: ^3.0
• phpunit/phpunit: ^8.0

MIT

• api
• boilerplate
• laravel
• jwt

README

This is a boilerplate for writing RESTful API projects using Laravel, a "Starter Kit" you can use to build your API in seconds.

Packages:

• JWT-Auth - tymondesigns/jwt-auth
• Laravel-CORS barryvdh/laravel-cors

Require:

• PHP: ^7.2

Features

• JWT Authentication
• Basic Features: Registration, Login, Update Profile & Password
• JSON API Format response.
• Unit/Feature Testing.
• Frontend Vue.js starter kit ready example ( https://github.com/kennethtomagan/Vue-CLI-Boilerplate ).

Installation

composer create-project kennethtomagan/laravel-6-api-boilerplate myNewProject;

Install Dependencies

$ composer install

Configure the Environment

Create .env file:

$ cat .env.example > .env

Run php artisan key:generate and php artisan jwt:secret

Migrate and Seed the Database

$ php artisan migrate:fresh --seed

Route API Endpoint

• Postman API Documentation Starter Kit https://documenter.getpostman.com/view/880526/SVtN3BkG?version=latest

Verb	URI	Controller	Notes
POST	http://localhost:8000/api/auth/login	AuthController	to do the login and get your access token
POST	http://localhost:8000/api/auth/register	RegisterController	to create a new user into your application
POST	http://localhost:8000/api/auth/recovery	ForgotPasswordController	to recover your credentials;
POST	http://localhost:8000/api/auth/reset	ResetPasswordController	to reset your password after the recovery (setup your mail credentials in .env file to avoid error);
POST	http://localhost:8000/api/auth/logout	LogoutController	to log out the user by invalidating the passed token;
GET	http://localhost:8000/api/profile	ProfileController	to get current user data
PUT	http://localhost:8000/api/profile	ProfileController	to update current user data
PUT	http://localhost:8000/api/profile/password	ProfileController	to update current user password