adoranwodo / laravelcorsmiddleware
Add CORS support to your Lumen / Laravel application
Requires
Requires (Dev)
- mockery/mockery: ^1.1
- orchestra/testbench: ~3.0
- phpunit/phpunit: ~7.0
- sempro/phpunit-pretty-print: ^1.0
This package is auto-updated.
Last update: 2024-04-12 03:47:05 UTC
README
Laravel Cors Middleware is a package that allows users enable Cross-Origin Resource Sharing (CORS) for their Laravel / Lumen applications by taking advantage of the middleware configuration.
Installation
Via Composer
$ composer require adoranwodo/laravelcorsmiddleware
Usage
Laravel
If you are using Laravel, please continue here. If you are using Lumen, please scroll down to the Lumen section.
Configuration
Please add the service provider to your config/app.php :
'providers' => [
...
AdoraNwodo\LaravelCorsMiddleware\LaravelCorsMiddlewareServiceProvider::class
]
There is a default configuration in config/laravelcorsmiddleware.php. Publish this file to your own config directory and change to your own values. You can publish the file by running the code below in your terminal:
php artisan vendor:publish --provider="AdoraNwodo\LaravelCorsMiddleware\LaravelCorsMiddlewareServiceProvider"
There are some instructions in the config. Please adhere strictly and you should be fine :).
Finally, you need to add this to your middleware. You can add it globally or to a middleware group.
Global Middleware (Laravel)
To use the CORS middleware globally (on all routes), go to app/Http/Kernel.php and add the laravelcorsmiddleware to your $middleware array like this:
protected $middleware = [
...
\AdoraNwodo\LaravelCorsMiddleware\LaravelCorsMiddleware::class,
]
Middleware Group (Laravel)
To use the CORS middleware only for specific routes or groups, go to app/Http/Kernel.php and add the laravelcorsmiddleware to your middleware group array like this:
protected $middlewareGroups = [
'web' => [
...
\AdoraNwodo\LaravelCorsMiddleware\LaravelCorsMiddleware::class,
],
'api' => [
...
],
];
Lumen
If you are using Lumen, please continue here. If you are using Laravel, please scroll up to the Laravel section
Configuration
Please create a /config directory in the parent directory and add create a new laravelcorsmiddleware.php file. Paste this into your new php file (You can edit the values as you like).
<?php
return [
/*
* __________ __________ ___________ __________
* | | | | | |
* | | | | | |
* | | | | | |
* | | | |___________| |__________
* | | | | \ |
* | | | | \ |
* | | | | \ |
* |__________ |__________| | \ ___________|
*
*
*
* LARAVEL CORS MIDDLEWARE
*
* Please add a list of values to allowedOrigins, allowedMethods and allowedHeaders.
* You can also choose to set the value of these to '*', but note that this is not advisable
* for allowedOrigins as this would give everyone access to your api.
*/
'allowCredentials' => true, //true or false. NOTE: Boolean NOT String. 'true' is different from true
'allowedOrigins' => ['*'], //array of strings e.g. ['*'] or ['https://mywebsite.com', 'https://anotherwebsite.com', ... ]
'allowedMethods' => ['*'], //array of strings e.g. ['*'] or ['GET', 'POST', ... ]
'allowedHeaders' => ['*'], //array of strings. e.g. ['*'] or ['Content-Type', 'Authorization', ... ]
'maxAge' => 86400, //number. e.g. 86400
];
Once this is done, you can go to bootstrap/app.php. Here, you will load the configuration file manually and register the service provider like this:
$app->configure('laravelcorsmiddleware'); //load the config file
$app->register(AdoraNwodo\LaravelCorsMiddleware\LaravelCorsMiddlewareServiceProvider::class); //register the service provider
Finally, you need to add this to your middleware. You can add it globally or to a middleware group.
Global Middleware (Lumen)
To use the CORS middleware globally (on all routes), go to bootstrap/app.php and add the laravelcorsmiddleware to your $middleware array like this:
$app->middleware([
...
\AdoraNwodo\LaravelCorsMiddleware\LaravelCorsMiddleware::class,
]);
Middleware Group (Lumen)
To use the CORS middleware only for specific routes or groups, go to bootstrap/app.php and add the laravelcorsmiddleware to your middleware group array like this:
$app->routeMiddleware([
'cors' => \AdoraNwodo\LaravelCorsMiddleware\LaravelCorsMiddleware::class
]);
Change log
Please see the changelog for more information on what has changed recently.
Contributing
Please see contributing.md for details and a todolist.
Security
If you discover any security related issues, please email nennenwodo@gmail.com instead of using the issue tracker.
License
osl 3.0. Please see the license file for more information.