Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamnotstatic/laravel-api-auth
A Laravel Package for easy API authentication setup with passport
https://github.com/iamnotstatic/laravel-api-auth
laravel laravel-api laravel-authentication laravel-passport oauth2-laravel
Last synced: about 8 hours ago
JSON representation
A Laravel Package for easy API authentication setup with passport
- Host: GitHub
- URL: https://github.com/iamnotstatic/laravel-api-auth
- Owner: iamnotstatic
- License: mit
- Created: 2020-04-05T17:01:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-04-10T16:45:58.000Z (over 4 years ago)
- Last Synced: 2024-08-10T12:26:03.491Z (about 2 months ago)
- Topics: laravel, laravel-api, laravel-authentication, laravel-passport, oauth2-laravel
- Language: PHP
- Homepage:
- Size: 39.1 KB
- Stars: 31
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel API Auth
[](https://github.com/iamnotstatic/laravel-api-auth/issues)
[](https://github.com/iamnotstatic/laravel-api-auth/stargazers)
[](https://github.com/iamnotstatic/laravel-api-auth)
[](https://github.com/iamnotstatic/laravel-api-auth)
## Introduction
> A Laravel Package for easy API authentication setup with passport
## Installation
To get the latest version of Laravel Api Auth, simply require it
```bash
composer require iamnotstatic/laravel-api-auth
```
## Configuration
You can publish the configuration file using this command:
```bash
php artisan vendor:publish --provider="Iamnotstatic\LaravelAPIAuth\LaravelAPIAuthServiceProvider"
```
Migrate your database after installing the package
```bash
php artisan migrate
```
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
```bash
php artisan passport:install
```
Next, you should call the Passport::routes method within the boot method of your AuthServiceProvider. This method will register the routes necessary to issue access tokens and revoke access tokens, clients, and personal access tokens:
```php
'App\Policies\ModelPolicy',
];
/**
* Register any authentication / authorization services.
*
* @return void
*/
public function boot()
{
$this->registerPolicies();
Passport::routes();
}
}
```
In your config/auth.php configuration file, you should set the driver option of the api authentication guard to passport. This will instruct your application to use Passport's TokenGuard when authenticating incoming API requests:
```php
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
'api' => [
'driver' => 'passport',
'provider' => 'users',
],
],
```
In your config/auth.php configuration file, you should set the model option of the package model. This will provide a few helper methods to allow you to inspect the authenticated user's token and scopes:
```php
'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => Iamnotstatic\LaravelAPIAuth\Models\User::class,
],
// 'users' => [
// 'driver' => 'database',
// 'table' => 'users',
// ],
],
```
## Usage
Now, we can simple test by rest client tools (Postman), So I test it and you can see below screenshots.
> In this api you have to set two header as listed below:
```bash
Accept: application/json
```
Register
Login
Logout
Get User
Forgotten Password
Reset Passowrd
## Contributing
Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.
## How can I thank you?
Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!
Don't forget to [follow me on twitter](https://twitter.com/iamnotstatic)!
Thanks!
Abdulfatai Suleiman.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.