PHP Classes

PHP REST API Boiler Plate: Provide API with user access management functions

Recommend this page to a friend!
     
  Info   Documentation   View files Files   Install with Composer Install with Composer   Download Download   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not yet rated by the usersTotal: 300 All time: 7,419 This week: 57Up
Version License PHP version Categories
api-boiler-plate 1.0.0The PHP License7User Management, Web services, PHP 7, T...
Description 

Author

Busari Ridwan

This package can provide API with user access management functions.

It provides the basis of implementation of a REST API that already have API functions that can be user to manipulate records of users that may have access to user accounts. Currently it provides functions for:

- User authentication functions like login, register, verify email, password recovery, password reset
- User account create, retrieve, update and delete
- User account role create, retrieve, update, delete and permission assignment
- User account permissions create, retrieve, update and delete

Innovation Award
PHP Programming Innovation award nominee
May 2020
Number 4		 Many APIs are available to provide useful services to the API users. The services that each API provides may vary from user to user.

This package provides a solution to implement an API that already comes with built-in user access management operations like user registration and authentication.

Manuel Lemos
Picture of Busari Ridwan
  Performance   Level  

Level 1 Star

 Innovation award
Innovation award
Nominee: 4x

 

Documentation

About Rapido Api Boiler Plate

This is a complete api boiler plate that allows you to easily set up and get your development work going without any hassle. The boiler plate is built on Laravel, one of PHP's most popular framework. It is developed by rheedwahn. The boiler plate has the following implementation out of the box

  • User Authentication using laravel passport for token management
  • User Registration
  • Roles Management
  • Permissions Management
  • Role Based Access Level Control (This can be modified to permission based for granular control)
  • Profile Management

Api Endpoints

To download the postman collection, please click on this link. The endpoints has the following folder structure

  • Auth - Login Request - Register Request - Verify Email Request - Temporary Login Request - Forgot Password Request - Reset Password Request
  • User - Me Request - Update Request - Store Request - Update User by Admin Request - Delete Request - List Request
  • Roles - List Request - Store Request - Update Request - Delete Request - Assing Permissions to Role Request
  • Permissions - List Request - Store request - Update Request - Delete Request

Installation

Setting up this boiler plate is easy especially for those familiar with the laravel ecosystem. The following steps are required to get this up and running

  • Clone the project
  • Run `composer install` to install dependency
  • Copy the `.env.example` to `.env` file
  • Set up the database credentials to suit your configuration
  • Run `php artisan migrate` to migrate the tables into your database
  • Run `php artisan passport:install` to get your personal access client and grant created
  • Run `php artisan db:seed` to seed an initial user to your users table
  • Download the postman collection from the link above
  • Import the downloaded collection
  • Serve the application on any port of your choice

Todo

  • Implement Unit and feature tests on all the functionalities

Contributing

For anyone willing to contribute to this boiler plate, please dont hesitate to open a PR with your contributions

Security Vulnerabilities

If you discover a security vulnerability within this boiler plate, please open a PR with your fixes.

License

Rapido Api boiler plate is open-sourced software licensed under the MIT license.


  Files folder image Files (112)  
File Role Description
Files folder imageapp (12 directories)
Files folder imagebootstrap (1 file)
Files folder imageconfig (15 files)
Files folder imagedatabase (3 directories)
Files folder imagepublic (3 files)
Files folder imageresources (4 directories)
Files folder imageroutes (4 files)
Files folder imagetests (2 files, 2 directories)
Accessible without login Plain text file .env.example Data Auxiliary data
Accessible without login Plain text file .styleci.yml Data Auxiliary data
Plain text file artisan Class Class source
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file composer.lock Data Auxiliary data
Accessible without login Plain text file package-lock.json Data Auxiliary data
Accessible without login Plain text file package.json Data Auxiliary data
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation
Accessible without login Plain text file server.php Aux. Auxiliary script
Accessible without login Plain text file webpack.mix.js Data Auxiliary data

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.
Install with Composer Install with Composer
Downloadapi-boiler-plate-2020-05-15.zip 190KB
Downloadapi-boiler-plate-2020-05-15.tar.gz 159KB
Install with ComposerInstall with Composer
 Version Control Unique User Downloads Download Rankings  
 100%
Total:300
This week:0
All time:7,419
This week:57Up

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.