Integrate with Laravel
Facade, Blade @flag and route middleware.
Before you start#
- A server key (
fs_srv_…) from the API Keys page of your console. See API keys for how keys differ. - The address of your FlagSwift server, for example
https://flags.example.com. - A flag to read. Create one in the console and turn it on in an environment.
Keep the key on the server
Store the key in your secrets manager or an environment variable. Never commit it and never send it to a browser.
Your server#
Enter your server address and, if your key covers every environment of the project, the environment to read. The examples below fill in as you type. Nothing is sent anywhere: the values stay in this browser.
Set up#
Environment
bash FLAGSWIFT_BASE_URL=https://flags.example.com FLAGSWIFT_API_KEY=fs_srv_... # private; from the API Keys page # FLAGSWIFT_CACHE_STORE=redis # a store shared by your workersInstall
bash composer require flagswift/flagswift-laravel php artisan vendor:publish --tag=flagswift-config # optionalUse
php use FlagSwift\Laravel\Facades\FlagSwift; FlagSwift::isEnabled('new-checkout'); // the authenticated user FlagSwift::isEnabled('new-checkout', 'user-42'); // an explicit identifier FlagSwift::variant('button-colour'); feature('new-checkout'); // helper // routes/web.php: 404 when the flag is off Route::get('/checkout', CheckoutController::class)->middleware('flag:new-checkout');Blade
blade @flag('new-checkout') <x-new-checkout /> @else <x-old-checkout /> @endflag
Verify it works#
Before you run your app, check the key, the address and the environment with one request. A server key downloads the configuration your app will evaluate locally.
curl -s "https://flags.example.com/api/v1/evaluation/server?mode=config" \
-H "Authorization: Bearer $FLAGSWIFT_SERVER_KEY"A 200 response with your flags means everything is wired up. If it fails, Troubleshooting lists the usual causes.