PHP Classes

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

Recommend this page to a friend!
     
  Info   View files Documentation   View files View files (112)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not yet rated by the usersTotal: 291 All time: 7,470 This week: 148Up
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  
Name: Busari Ridwan <contact>
Classes: 4 packages by
Country: Nigeria Nigeria
Age: ???
All time rank: 346924 in Nigeria Nigeria
Week rank: 578 Up9 in Nigeria Nigeria Up

Level 1 Star

 Innovation award
Innovation award
Nominee: 3x

Details

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  
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

  Files folder image Files  /  app  
File Role Description
Files folder imageConsole (1 file)
Files folder imageEnum (1 file)
Files folder imageEvents (1 file)
Files folder imageExceptions (1 file)
Files folder imageHttp (1 file, 4 directories)
Files folder imageLibraries (1 file)
Files folder imageListeners (1 file)
Files folder imageModels (3 files)
Files folder imageNotifications (2 files)
Files folder imageProviders (5 files)
Files folder imageServices (1 directory)
Files folder imageTraits (1 file)

  Files folder image Files  /  app  /  Console  
File Role Description
  Plain text file Kernel.php Class Class source

  Files folder image Files  /  app  /  Enum  
File Role Description
  Plain text file UserStatus.php Class Class source

  Files folder image Files  /  app  /  Events  
File Role Description
  Plain text file NewUser.php Class Class source

  Files folder image Files  /  app  /  Exceptions  
File Role Description
  Plain text file Handler.php Class Class source

  Files folder image Files  /  app  /  Http  
File Role Description
Files folder imageControllers (1 file, 1 directory)
Files folder imageMiddleware (8 files)
Files folder imageRequests (1 directory)
Files folder imageResources (1 directory)
  Plain text file Kernel.php Class Class source

  Files folder image Files  /  app  /  Http  /  Controllers  
File Role Description
Files folder imageApi (6 directories)
  Plain text file Controller.php Class Class source

  Files folder image Files  /  app  /  Http  /  Controllers  /  Api  
File Role Description
Files folder imageAuth (3 files)
Files folder imageDashboard (1 file)
Files folder imageMe (1 file)
Files folder imagePermission (1 file)
Files folder imageRole (1 file)
Files folder imageUser (1 file)

  Files folder image Files  /  app  /  Http  /  Controllers  /  Api  /  Auth  
File Role Description
  Plain text file ForgotPasswordController.php Class Class source
  Plain text file LoginController.php Class Class source
  Plain text file RegisterController.php Class Class source

  Files folder image Files  /  app  /  Http  /  Controllers  /  Api  /  Dashboard  
File Role Description
  Plain text file DashboardController.php Class Class source

  Files folder image Files  /  app  /  Http  /  Controllers  /  Api  /  Me  
File Role Description
  Plain text file MeController.php Class Class source

  Files folder image Files  /  app  /  Http  /  Controllers  /  Api  /  Permission  
File Role Description
  Plain text file PermissionController.php Class Class source

  Files folder image Files  /  app  /  Http  /  Controllers  /  Api  /  Role  
File Role Description
  Plain text file RoleController.php Class Class source

  Files folder image Files  /  app  /  Http  /  Controllers  /  Api  /  User  
File Role Description
  Plain text file UserController.php Class Class source

  Files folder image Files  /  app  /  Http  /  Middleware  
File Role Description
  Plain text file ApiLogger.php Class Class source
  Plain text file Authenticate.php Class Class source
  Plain text file CheckForMaintenanceMode.php Class Class source
  Plain text file EncryptCookies.php Class Class source
  Plain text file RedirectIfAuthenticated.php Class Class source
  Plain text file TrimStrings.php Class Class source
  Plain text file TrustProxies.php Class Class source
  Plain text file VerifyCsrfToken.php Class Class source

  Files folder image Files  /  app  /  Http  /  Requests  
File Role Description
Files folder imageApi (4 directories)

  Files folder image Files  /  app  /  Http  /  Requests  /  Api  
File Role Description
Files folder imageAuth (4 files)
Files folder imagePermission (3 files)
Files folder imageRole (4 files)
Files folder imageUser (3 files)

  Files folder image Files  /  app  /  Http  /  Requests  /  Api  /  Auth  
File Role Description
  Plain text file ForgotPasswordRequest.php Class Class source
  Plain text file LoginRequest.php Class Class source
  Plain text file RegisterRequest.php Class Class source
  Plain text file ResetPasswordRequest.php Class Class source

  Files folder image Files  /  app  /  Http  /  Requests  /  Api  /  Permission  
File Role Description
  Plain text file ListRequest.php Class Class source
  Plain text file StoreRequest.php Class Class source
  Plain text file UpdateRequest.php Class Class source

  Files folder image Files  /  app  /  Http  /  Requests  /  Api  /  Role  
File Role Description
  Plain text file AssignPermissionRequest.php Class Class source
  Plain text file ListRequest.php Class Class source
  Plain text file StoreRequest.php Class Class source
  Plain text file UpdateRequest.php Class Class source

  Files folder image Files  /  app  /  Http  /  Requests  /  Api  /  User  
File Role Description
  Plain text file ListRequest.php Class Class source
  Plain text file UpdateRequest.php Class Class source
  Plain text file UpdateUserByAdminRequest.php Class Class source

  Files folder image Files  /  app  /  Http  /  Resources  
File Role Description
Files folder imageApi (3 directories)

  Files folder image Files  /  app  /  Http  /  Resources  /  Api  
File Role Description
Files folder imagePermission (1 file)
Files folder imageRole (1 file)
Files folder imageUser (2 files)

  Files folder image Files  /  app  /  Http  /  Resources  /  Api  /  Permission  
File Role Description
  Plain text file PermissionResource.php Class Class source

  Files folder image Files  /  app  /  Http  /  Resources  /  Api  /  Role  
File Role Description
  Plain text file RoleResource.php Class Class source

  Files folder image Files  /  app  /  Http  /  Resources  /  Api  /  User  
File Role Description
  Plain text file ProfileResource.php Class Class source
  Plain text file UserResource.php Class Class source

  Files folder image Files  /  app  /  Libraries  
File Role Description
  Plain text file Utilities.php Class Class source

  Files folder image Files  /  app  /  Listeners  
File Role Description
  Plain text file SendNewUserEmail.php Class Class source

  Files folder image Files  /  app  /  Models  
File Role Description
  Plain text file ApiLog.php Class Class source
  Plain text file Profile.php Class Class source
  Plain text file User.php Class Class source

  Files folder image Files  /  app  /  Notifications  
File Role Description
  Plain text file NewUserNotification.php Class Class source
  Plain text file SendTemporaryLinkMail.php Class Class source

  Files folder image Files  /  app  /  Providers  
File Role Description
  Plain text file AppServiceProvider.php Class Class source
  Plain text file AuthServiceProvider.php Class Class source
  Plain text file BroadcastServiceProvider.php Class Class source
  Plain text file EventServiceProvider.php Class Class source
  Plain text file RouteServiceProvider.php Class Class source

  Files folder image Files  /  app  /  Services  
File Role Description
Files folder imageUser (2 files)

  Files folder image Files  /  app  /  Services  /  User  
File Role Description
  Plain text file AdminUserUpdateService.php Class Class source
  Plain text file UpdateService.php Class Class source

  Files folder image Files  /  app  /  Traits  
File Role Description
  Plain text file TemporaryUrlTrait.php Class Class source

  Files folder image Files  /  bootstrap  
File Role Description
  Plain text file app.php Class Class source

  Files folder image Files  /  config  
File Role Description
  Plain text file app.php Class Class source
  Plain text file auth.php Class Class source
  Accessible without login Plain text file broadcasting.php Aux. Auxiliary script
  Accessible without login Plain text file cache.php Aux. Auxiliary script
  Accessible without login Plain text file cors.php Aux. Auxiliary script
  Accessible without login Plain text file database.php Aux. Auxiliary script
  Accessible without login Plain text file filesystems.php Aux. Auxiliary script
  Accessible without login Plain text file hashing.php Aux. Auxiliary script
  Plain text file logging.php Class Class source
  Accessible without login Plain text file mail.php Aux. Auxiliary script
  Plain text file permission.php Class Class source
  Accessible without login Plain text file queue.php Aux. Auxiliary script
  Accessible without login Plain text file services.php Aux. Auxiliary script
  Accessible without login Plain text file session.php Aux. Auxiliary script
  Accessible without login Plain text file view.php Aux. Auxiliary script

  Files folder image Files  /  database  
File Role Description
Files folder imagefactories (3 files)
Files folder imagemigrations (5 files)
Files folder imageseeds (3 files)

  Files folder image Files  /  database  /  factories  
File Role Description
  Plain text file ProfileFactory.php Class Class source
  Plain text file RoleFactory.php Class Class source
  Plain text file UserFactory.php Class Class source

  Files folder image Files  /  database  /  migrations  
File Role Description
  Plain text file 2014_10_12_000000_create_users_table.php Class Class source
  Plain text file 2019_08_19_000000_...iled_jobs_table.php Class Class source
  Plain text file 2020_05_08_082913_...rmission_tables.php Class Class source
  Plain text file 2020_05_08_084358_..._api_logs_table.php Class Class source
  Plain text file 2020_05_11_103517_..._profiles_table.php Class Class source

  Files folder image Files  /  database  /  seeds  
File Role Description
  Plain text file DatabaseSeeder.php Class Class source
  Plain text file RolesTableSeeder.php Class Class source
  Plain text file UsersTableSeeder.php Class Class source

  Files folder image Files  /  public  
File Role Description
  Accessible without login Plain text file .htaccess Data Auxiliary data
  Plain text file index.php Class Class source
  Accessible without login Plain text file robots.txt Doc. Documentation

  Files folder image Files  /  resources  
File Role Description
Files folder imagejs (2 files)
Files folder imagelang (1 directory)
Files folder imagesass (1 file)
Files folder imageviews (1 file)

  Files folder image Files  /  resources  /  js  
File Role Description
  Accessible without login Plain text file app.js Data Auxiliary data
  Accessible without login Plain text file bootstrap.js Data Auxiliary data

  Files folder image Files  /  resources  /  lang  
File Role Description
Files folder imageen (4 files)

  Files folder image Files  /  resources  /  lang  /  en  
File Role Description
  Accessible without login Plain text file auth.php Aux. Auxiliary script
  Accessible without login Plain text file pagination.php Aux. Auxiliary script
  Accessible without login Plain text file passwords.php Aux. Auxiliary script
  Accessible without login Plain text file validation.php Aux. Auxiliary script

  Files folder image Files  /  resources  /  sass  
File Role Description
  Accessible without login Plain text file app.scss Data Auxiliary data

  Files folder image Files  /  resources  /  views  
File Role Description
  Accessible without login Plain text file welcome.blade.php Aux. Auxiliary script

  Files folder image Files  /  routes  
File Role Description
  Accessible without login Plain text file api.php Example Example script
  Accessible without login Plain text file channels.php Example Example script
  Accessible without login Plain text file console.php Example Example script
  Accessible without login Plain text file web.php Aux. Auxiliary script

  Files folder image Files  /  tests  
File Role Description
Files folder imageFeature (1 file)
Files folder imageUnit (1 file)
  Plain text file CreatesApplication.php Class Class source
  Plain text file TestCase.php Class Class source

  Files folder image Files  /  tests  /  Feature  
File Role Description
  Plain text file ExampleTest.php Class Class source

  Files folder image Files  /  tests  /  Unit  
File Role Description
  Plain text file ExampleTest.php Class Class source

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:291
This week:0
All time:7,470
This week:148Up

  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.