Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pktharindu/laravel-api-boilerplate-passport
An API Boilerplate to create a ready-to-use REST API in seconds.
https://github.com/pktharindu/laravel-api-boilerplate-passport
api boilerplate cors dingo hacktoberfest laravel passport rest
Last synced: about 9 hours ago
JSON representation
An API Boilerplate to create a ready-to-use REST API in seconds.
- Host: GitHub
- URL: https://github.com/pktharindu/laravel-api-boilerplate-passport
- Owner: pktharindu
- License: mit
- Created: 2018-04-20T05:35:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-27T03:17:21.000Z (over 1 year ago)
- Last Synced: 2023-04-27T05:14:27.277Z (over 1 year ago)
- Topics: api, boilerplate, cors, dingo, hacktoberfest, laravel, passport, rest
- Language: PHP
- Homepage:
- Size: 422 KB
- Stars: 23
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://github.com/laravel/passport)
- Dingo API - [dingo/api](https://github.com/dingo/api)
- Laravel-CORS [barryvdh/laravel-cors](http://github.com/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
1. run `composer create-project pktharindu/laravel-api-boilerplate-passport newProject`;
2. 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! :smirk:
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 :muscle: 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 :innocent:. 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](http://opensource.org/licenses/MIT).