laravel-api-guard maintained by naviisml
Description
A API guard for Laravel.
Author
Last update
2026/01/21 13:55
(dev-master)
License
Downloads
67
Laravel API Guard
A lightweight Laravel package to authenticate requests using API keys via a custom guard.
Features
- Auth guard:
auth:apikey - Secure access with public/private key headers
- Artisan command to generate keys
Installation
- Install the package (
composer require naviisml/laravel-api-guard) - Publish the configuration* (
php artisan api-guard:install)
*This step is optional.
- A auth guard will automatically be added if it doesn't exist in the
config/auth.phpconfiguration.
'guards' => [
'apikey' => [
'driver' => 'apikey',
'provider' => 'users', // Optional
],
],
Usage
Authentication Guard
Use auth:apikey on API routes:
Route::middleware('auth:apikey')->group(function () {
Route::get('/secure-endpoint', fn() => 'Access granted');
});
Required Headers
| Header | Description |
|---|---|
X-Public-Key |
Public API key |
X-Private-Key |
Private API key |
Generate Keys
Run the artisan command:
php artisan make:api-keys