Je API verkeer beperken in Laravel<\/h2>\n
Rate limiting is een mechanisme dat is ontworpen om het gebruik van de resources van je applicatie te beperken. Hoewel het veel toepassingen heeft, is het vooral nuttig voor openbare API’s in grote, schaalbare systemen. Het zorgt ervoor dat alle legitieme gebruikers eerlijke toegang behouden tot systeemresources.<\/p>\n
Rate limiting is bovendien cruciaal voor beveiliging, kostenbeheersing en algehele stabiliteit van het systeem. Het kan op verzoeken gebaseerde aanvallen helpen voorkomen, zoals DDoS aanvallen (Distributed Denial-of-Service). Dit soort aanval is gebaseerd op het verzenden van herhaalde verzoeken om de toegang tot een applicatie of website server te overweldigen en te verstoren.<\/p>\n
Er zijn verschillende methoden om rate limiting te implementeren. Je kunt variabelen gebruiken die de aanvrager karakteriseren om te bepalen wie toegang krijgt tot je applicatie en hoe vaak. Enkele veelgebruikte variabelen zijn:<\/p>\n
- \n
- IP adres<\/strong> – Door rate limits te implementeren op basis van IP adressen kun je het aantal aanvragen per adres beperken. Deze methode is vooral nuttig in omstandigheden waarin gebruikers toegang kunnen krijgen tot een applicatie zonder referenties op te geven.<\/li>\n
- API sleutel<\/strong> – Het beperken van toegang via API sleutels houdt in dat je de aanvrager voorziet van vooraf gegenereerde API sleutels en dat je per sleutel rate limits instelt. Met deze aanpak kun je ook verschillende toegangsniveaus toepassen op de gegenereerde API sleutels.<\/li>\n
- Client ID<\/strong> – Je kunt ook vooraf een Client ID genereren die een gebruiker kan invoegen in de header of body van API verzoeken. Met deze methode kun je toegangsniveaus per ID instellen om ervoor te zorgen dat geen enkele client systeembronnen kan monopoliseren.<\/li>\n<\/ul>\n
Laravel Middleware<\/h3>\n
Middleware biedt een handig mechanisme voor het inspecteren en filteren van HTTP-verzoeken<\/a> die een applicatie binnenkomen. In wezen is het een laag code tussen de applicatie en de onderliggende infrastructuur om communicatie tussen de bronnen mogelijk te maken.<\/p>\n
Zo implementeer je rate limits<\/h2>\n
Deze tutorial maakt gebruik van een bestaande mini-library API op het Laravel 10 framework om het gebruik van Laravel throttling te demonstreren. Het voorbeeld startproject bevat de basis create, read, update en delete (CRUD) implementaties die nodig zijn om booksin een collectie te beheren en twee extra routes om een aantal rate-limiting concepten te demonstreren.<\/p>\n
Vereisten<\/h3>\n
De tutorial gaat ervan uit dat je bekend bent met de basisprincipes van API ontwikkeling in Laravel. Zorg ervoor dat je over het volgende beschikt:<\/p>\n
- \n
- PHP 8.2, Composer<\/a> en Laravel<\/a> ge\u00efnstalleerd en geconfigureerd hebt op je lokale machine<\/li>\n
- Een actief Kinsta account<\/a><\/li>\n
- Een account op GitHub<\/a>, GitLab<\/a> of Bitbucket<\/a> om je code te pushen<\/li>\n<\/ul>\n
Je gebruikt ook MyKinsta<\/a> om deze API in te stellen en te implementeren. Je kunt de meegeleverde projecttemplates<\/a> volgen en een voorbeeld van het eindresultaat bekijken vanuit de volledige sourcecode<\/a>.<\/p>\n
Laravel applicatie opzetten<\/h2>\n
- \n
- Om te beginnen kloon je de projecttemplate<\/a>.<\/li>\n
- Maak vervolgens een .env<\/strong> bestand aan in de hoofdmap van het project en kopieer de inhoud van .env.example<\/strong> hierin.<\/li>\n
- Voltooi vervolgens de installatie met de volgende commando’s om de dependencies van de app te installeren en de app key te genereren.<\/li>\n<\/ol>\n
composer install\nphp artisan key:generate<\/code><\/pre>\nAls dit commando niet automatisch de app key aan je .env<\/strong> bestand toevoegt, voer dan
php artisan key:generate --show<\/code> uit, kopieer de gegenereerde sleutel en plak deze in je .env<\/strong> bestand als de waarde voorAPP_KEY<\/code>.<\/p>\n- \n
- Zodra de installatie van de dependencies en het genereren van de app-sleutel voltooid zijn, start je de applicatie met het volgende commando:<\/li>\n<\/ol>\n
php artisan serve<\/code><\/pre>\nDit commando start de applicatie en maakt deze toegankelijk via de browser op
https:\/\/127.0.0.1:8000<\/code>.<\/p>\n- \n
- Bezoek de URL om te bevestigen dat de Laravel welkomstpagina verschijnt:<\/li>\n<\/ol>\n
\n ![\"Op](\"https:\/\/kinsta.com\/wp-content\/uploads\/2023\/07\/laravel-throttle-welcome-page.png\")
Het Laravel welkomstscherm<\/figcaption><\/figure><\/figure>\n Configuratie database<\/h2>\n
Laten we de applicatiedatabase configureren en instellen in MyKinsta<\/a>.<\/p>\n
- \n
- Navigeer naar het dashboard van je MyKinsta account en klik op de knop Dienst toevoegen<\/strong>:<\/li>\n<\/ol>\n
\n ![\"Het](\"https:\/\/kinsta.com\/wp-content\/uploads\/2023\/07\/laravel-throttle-mykinsta-services.png\")
MyKinsta dashboard met verschillende services geconfigureerd.<\/figcaption><\/figure><\/figure>\n - \n
- Klik in de lijst Dienst toevoegen<\/strong> op Database<\/strong> en configureer de parameters om je database-instantie te starten:<\/li>\n<\/ol>\n
\n ![\"De](\"https:\/\/kinsta.com\/wp-content\/uploads\/2023\/07\/laravel-throttle-mykinsta-database.png\")
MyKinsta database configuratie.<\/figcaption><\/figure><\/figure>\n Deze tutorial gebruikt MariaDB, maar je kunt elke door Laravel ondersteunde database kiezen die Kinsta biedt.<\/p>\n
- \n
- Zodra je je databasegegevens hebt ingevoerd, klik je op de knop Doorgaan<\/strong> om het proces af te ronden.<\/li>\n<\/ol>\n
Databases die worden aangeboden op Kinsta hebben interne en externe verbindingsparameters. Je moet interne verbindingsparameters gebruiken voor applicaties die binnen hetzelfde Kinsta account worden gehost en externe parameters voor externe verbindingen. Gebruik daarom de externe databasegegevens van Kinsta voor je applicatie.<\/p>\n
- \n
- Kopieer de .env<\/strong> referenties van de database van je app en werk ze bij met de externe referenties in de schermafbeelding hieronder:<\/li>\n<\/ol>\n
\n ![\"Het](\"https:\/\/kinsta.com\/wp-content\/uploads\/2023\/07\/laravel-throttle-mykinsta-database-settings.png\")
MyKinsta database configuratie details.<\/figcaption><\/figure><\/figure>\n DB_CONNECTION=mysql\nDB_HOST=your_host_name\nDB_PORT=your_port\nDB_DATABASE=your_database_info\nDB_USERNAME=your_username\nDB_PASSWORD=your_password<\/code><\/pre>\n- \n
- Nadat je de databasegegevens hebt ingevuld, test je de verbinding door de databasemigratie toe te passen met het onderstaande commando:<\/li>\n<\/ol>\n
php artisan migrate<\/code><\/pre>\nAls alles naar behoren werkt, zou je een respons moeten zien zoals hieronder.<\/p>\n
\n ![\"De](\"https:\/\/kinsta.com\/wp-content\/uploads\/2023\/07\/laravel-throttle-terminal-database-migration.png\")
Succesvolle databasemigratie in een terminal.<\/figcaption><\/figure><\/figure>\n - \n
- Gebruik vervolgens het volgende commando om de applicatieroutes op te sommen en de reeds ge\u00efmplementeerde routes te bekijken.<\/li>\n<\/ol>\n
php artisan route:list<\/code><\/pre>\nJe zou nu de beschikbare API endpoints moeten zien:<\/p>\n
\n ![\"De](\"https:\/\/kinsta.com\/wp-content\/uploads\/2023\/07\/laravel-throttle-terminal-api-endpoints.png\")
De routelijst van de toepassing op de terminal.<\/figcaption><\/figure><\/figure>\n - \n
- Start de applicatie en controleer of alles nog steeds goed werkt. Je kunt deze endpoints via de terminal testen met een tool als Postman<\/a> of CURL.<\/li>\n<\/ol>\n
Zo stel je een rate limit in een Laravel applicatie<\/h2>\n
Er zijn verschillende rate limit technieken beschikbaar voor Laravel applicaties. Je kunt een set IP adressen<\/a> blokkeren of op duur gebaseerde aanvraaglimieten afdwingen op basis van het IP adres of user_id van een gebruiker. Vervolgens pas je elk van deze methoden toe.<\/p>\n
- \n
- Installeer het Laravel Throttle pakket met het volgende commando:<\/li>\n<\/ol>\n
composer require \"graham-campbell\/throttle:^10.0\"<\/code><\/pre>\n- \n
- Je kunt ook extra wijzigingen aanbrengen in de Laravel Throttle configuraties door het
vendor configurations<\/code> bestand te publiceren:<\/li>\n<\/ol>\nphp artisan vendor:publish --provider=\"GrahamCampbell\\Throttle\\ThrottleServiceProvider\"<\/code><\/pre>\nIP adressen blokkeren<\/h3>\n
Met deze techniek voor het beperken van de snelheid kun je verzoeken blokkeren van een bepaalde set IP adressen.<\/p>\n
- \n
- Maak om te beginnen de benodigde middleware:<\/li>\n<\/ol>\n
php artisan make:middleware RestrictMiddleware<\/code><\/pre>\n- \n
- Open vervolgens het aangemaakte app\/Http\/Middleware\/RestrictMiddleware.php<\/strong> middleware-bestand en vervang de code in de functie
handle<\/code> door het onderstaande fragment. Zorg ervoor dat jeuse App;<\/code> toevoegt aan de lijst met imports bovenaan het bestand.<\/li>\n<\/ol>\n$restrictedIps = ['127.0.0.1', '102.129.158.0'];\nif(in_array($request->ip(), $restrictedIps)){\n App::abort(403, 'Request forbidden');\n}\nreturn $next($request);<\/code><\/pre>\n- \n
- Maak in het bestand app\/Http\/Kernel.php<\/strong> een alias aan voor deze middleware-app door de array
middlewareAliases<\/code> als volgt aan te passen:\nprotected $middlewareAliases = [\n. . .\n'custom.restrict' => \\App\\Http\\Middleware\\RestrictMiddleware::class,\n];<\/code><\/pre>\n- \n
- Pas deze middleware vervolgens als volgt toe op de
\/restricted-route<\/code> in het bestand routes\/api.php<\/strong> en test:<\/li>\n<\/ol>\nRoute::middleware(['custom.restrict'])->group(function () {\n Route::get('\/restricted-route', [BookController::class, 'getBooks']);\n});<\/code><\/pre>\nAls het goed werkt, blokkeert deze middleware alle verzoeken van de IP’s in de
$restrictedIps<\/code> array:127.0.0.1<\/code> en102.129.158.0<\/code>. Verzoeken van deze IP’s geven een 403 Forbidden<\/strong> respons, zoals hieronder te zien is:<\/p>\n\n ![\"De](\"https:\/\/kinsta.com\/wp-content\/uploads\/2023\/07\/laravel-throttle-postman-returns-403.png\")
Een 403 Forbidden respons voor het \/restricted-route GET endpoint op Postman<\/figcaption><\/figure><\/figure>\n Zo beperk je verzoeken op IP adres<\/h3>\n
Ook kun je verzoeken beperken op basis van het IP adres van de gebruiker.<\/p>\n
- \n
- Pas de Throttle middleware toe op de routes
GET<\/code> enPATCH<\/code> van het\/book<\/code> endpoint in routes\/api.php<\/strong>:<\/li>\n<\/ol>\nRoute::middleware(['throttle:minute'])->group(function () {\n Route::get('\/book', [BookController::class, 'getBooks']);\n});\n\nRoute::middleware(['throttle:5,1'])->group(function () {\n Route::patch('\/book', [BookController::class, 'updateBook']);\n});<\/code><\/pre>\n- \n
- Je moet ook de functie
configureRateLimiting<\/code> in het bestand app\/Providers\/RouteServiceProvider<\/strong> bijwerken met de middleware die je hebt toegevoegd aan de bovenstaande routes.<\/li>\n<\/ol>\n\u2026 \nRateLimiter::for('minute', function (Request $request) {\n return Limit::perMinute(5)->by($request->ip());\n});<\/code><\/pre>\nDeze configuratie beperkt verzoeken aan het
\/book GET<\/code> endpoint tot 5 per minuut, zoals hieronder getoond.<\/p>\n\n ![\"De](\"https:\/\/kinsta.com\/wp-content\/uploads\/2023\/07\/laravel-throttle-postman-returns-429.png\")
Een “429 Too Many Requests” antwoord voor het \/book GET endpoint op Postman.<\/figcaption><\/figure><\/figure>\n Hoe te beginnen op basis van gebruikers-ID en sessies<\/h3>\n
- \n
- Om rate limits in te schakelen met behulp van de parameters
user_id<\/code> ensession<\/code>, moet je de functieconfigureRateLimiting<\/code> in het bestand app\/Providers\/RouteServiceProvider<\/strong> bijwerken met de volgende aanvullende begrenzers en variabelen:<\/li>\n<\/ol>\n...\nRateLimiter::for('user', function (Request $request) {\n return Limit::perMinute(10)->by($request->user()?->id ?: $request->ip());\n});\nRateLimiter::for('session', function (Request $request) {\n return Limit::perMinute(15)->by($request->session()->get('key') ?: $request->ip());\n});<\/code><\/pre>\n- \n
- Pas ten slotte deze code toe op de routes
\/book\/{id} GET<\/code> en\/book POST<\/code> in het bestandroutes\/api.php<\/code>:<\/li>\n<\/ol>\nRoute::middleware(['throttle:user'])->group(function () {\n Route::get('\/book\/{id}', [BookController::class, 'getBook']);\n});\nRoute::middleware(['throttle:session'])->group(function () {\n Route::post('\/book', [BookController::class, 'createBook']);\n});<\/code><\/pre>\nDeze code beperkt verzoeken met respectievelijk
user_id<\/code> ensession<\/code>.<\/p>\nExtra methoden in Throttle<\/h3>\n
Laravel Throttle heeft verschillende aanvullende methoden<\/a> voor meer controle over je implementatie van de rate limit. Deze methoden zijn onder andere:<\/p>\n
- \n
attempt<\/code> – Voert een hit uit op het endpoint, verhoogt de hit-telling en geeft een boolean terug die aangeeft of de geconfigureerde hitlimiet is overschreden.<\/li>\nhit<\/code> – Voert een hit uit op de Throttle, verhoogt de hit-telling en retourneert$this<\/code> om een andere (optionele) method call mogelijk te maken.<\/li>\nclear<\/code> – Zet de Throttle telling terug op nul en geeft$this<\/code> terug, zodat je desgewenst nog een method call kunt doen.<\/li>\ncount<\/code> – Geeft het totale aantal hits voor de Throttle terug.<\/li>\ncheck<\/code> – Geeft een boolean terug dat aangeeft of de Throttle hitlimiet is overschreden.<\/li>\n<\/ul>\n- \n
- Om rate limits met behulp van deze methoden te onderzoeken, maak je een middleware app genaamd CustomMiddleware met behulp van het onderstaande commando:<\/li>\n<\/ol>\n
php artisan make:middleware CustomMiddleware<\/code><\/pre>\n- \n
- Voeg vervolgens de volgende importbestanden toe aan het nieuw aangemaakte middleware-bestand in app\/Http\/Middleware\/CustomMiddleware.php<\/strong>:<\/li>\n<\/ol>\n
use GrahamCampbell\\Throttle\\Facades\\Throttle;\nuse App;<\/code><\/pre>\n- \n
- Vervang vervolgens de inhoud van de methode
handle<\/code> door het volgende codefragment:<\/li>\n<\/ol>\n$throttler = Throttle::get($request, 5, 1);\nThrottle::attempt($request);\nif(!$throttler->check()){\n App::abort(429, 'Too many requests');\n}\nreturn $next($request);<\/code><\/pre>\n- \n
- Maak in het bestand app\/Http\/Kernel.php<\/strong> een alias aan voor deze middleware-app door de array
middlewareAliases<\/code> als volgt bij te werken.<\/li>\n<\/ol>\nprotected $middlewareAliases = [\n. . .\n'custom.throttle' => \\App\\Http\\Middleware\\CustomMiddleware::class, \n];<\/code><\/pre>\n- \n
- Pas vervolgens deze middleware toe op de
\/custom-route<\/code> in het bestand routes\/api.php<\/strong>:<\/li>\n<\/ol>\nRoute::middleware(['custom.throttle'])->group(function () {\n Route::get('\/custom-route', [BookController::class, 'getBooks']);\n});<\/code><\/pre>\nDe aangepaste middleware die zojuist is ge\u00efmplementeerd controleert of de throttle limiet is overschreden met de
check<\/code> methode. Als de limiet is overschreden, wordt er gereageerd met een 429 foutmelding. Anders wordt het verzoek doorgezet.<\/p>\nDe applicatie deployen op de Kinsta server<\/h2>\n
Nu je hebt onderzocht hoe je rate limiting kunt implementeren in een Laravel applicatie, kun je de applicatie deployen naar de Kinsta server om deze wereldwijd toegankelijk te maken.<\/p>\n
- \n
- Begin met het pushen van de bijgewerkte code naar GitHub, GitLab<\/a> of Bitbucket<\/a>.<\/li>\n
- Klik op je Kinsta dashboard op de Dienst toevoegen<\/strong> knop en selecteer Applicatie<\/strong> uit de lijst. Koppel je Git account aan je Kinsta account en selecteer de juiste repository om te deployen.<\/li>\n
- Onder Basisgegevens<\/strong> geef je de applicatie een naam en kies je het datacenter van je voorkeur. Zorg er ook voor dat je de benodigde applicatie omgevingsvariabelen hebt toegevoegd. Deze komen overeen met de variabelen in je lokale .env<\/strong> bestand: de
APP_KEY<\/code> en de database configuratie variabelen.<\/li>\n<\/ol>\n\n ![\"Het](\"https:\/\/kinsta.com\/wp-content\/uploads\/2023\/07\/laravel-throttle-mykinsta-app-details.png\")
Applicatiedetails op MyKinsta.<\/figcaption><\/figure><\/figure>\n - \n
- Klik op de knop Doorgaan<\/strong> om de omgevingsvariabelen voor het bouwen te selecteren. Je kunt de standaardwaarden laten staan, omdat Kinsta de benodigde parameters automatisch invult.<\/li>\n
- Op het tabblad Processen<\/strong> kun je de standaardwaarden laten staan of een naam voor je proces invoeren. Je kunt op dit tabblad ook de grootte van de pod en de instantie selecteren.<\/li>\n
- Op het tabblad Betaling<\/strong> zie je ten slotte een overzicht van je selecties. Voeg de betalingsoptie van je voorkeur toe om het proces af te ronden.<\/li>\n
- Klik op het tabblad Applicaties<\/strong> om een lijst met uitgerolde applicaties te bekijken.<\/li>\n
- Klik op de naam van de applicatie om de details van de deployments te bekijken, zoals hieronder getoond. Je kunt de URL van de applicatie gebruiken om toegang te krijgen.<\/li>\n<\/ol>\n
\n ![\"Het](\"https:\/\/kinsta.com\/wp-content\/uploads\/2023\/07\/laravel-throttle-mykinsta-app-deployments.png\")
Deployment details in het MyKinsta dashboard.<\/figcaption><\/figure><\/figure>\n De applicatie testen<\/h2>\n
- \n
- Gebruik het commando
php artisan serve<\/code> om de applicatie lokaal te testen.<\/li>\n<\/ol>\n
- Op het tabblad Processen<\/strong> kun je de standaardwaarden laten staan of een naam voor je proces invoeren. Je kunt op dit tabblad ook de grootte van de pod en de instantie selecteren.<\/li>\n
- Klik op je Kinsta dashboard op de Dienst toevoegen<\/strong> knop en selecteer Applicatie<\/strong> uit de lijst. Koppel je Git account aan je Kinsta account en selecteer de juiste repository om te deployen.<\/li>\n
- Begin met het pushen van de bijgewerkte code naar GitHub, GitLab<\/a> of Bitbucket<\/a>.<\/li>\n
- Pas vervolgens deze middleware toe op de
- Maak in het bestand app\/Http\/Kernel.php<\/strong> een alias aan voor deze middleware-app door de array
- Vervang vervolgens de inhoud van de methode
- Voeg vervolgens de volgende importbestanden toe aan het nieuw aangemaakte middleware-bestand in app\/Http\/Middleware\/CustomMiddleware.php<\/strong>:<\/li>\n<\/ol>\n
- Pas ten slotte deze code toe op de routes
- Om rate limits in te schakelen met behulp van de parameters
- Je moet ook de functie
- Pas de Throttle middleware toe op de routes
- Pas deze middleware vervolgens als volgt toe op de
- Maak in het bestand app\/Http\/Kernel.php<\/strong> een alias aan voor deze middleware-app door de array
- Open vervolgens het aangemaakte app\/Http\/Middleware\/RestrictMiddleware.php<\/strong> middleware-bestand en vervang de code in de functie
- Maak om te beginnen de benodigde middleware:<\/li>\n<\/ol>\n
- Je kunt ook extra wijzigingen aanbrengen in de Laravel Throttle configuraties door het
- Installeer het Laravel Throttle pakket met het volgende commando:<\/li>\n<\/ol>\n
- Start de applicatie en controleer of alles nog steeds goed werkt. Je kunt deze endpoints via de terminal testen met een tool als Postman<\/a> of CURL.<\/li>\n<\/ol>\n
- Gebruik vervolgens het volgende commando om de applicatieroutes op te sommen en de reeds ge\u00efmplementeerde routes te bekijken.<\/li>\n<\/ol>\n
- Nadat je de databasegegevens hebt ingevuld, test je de verbinding door de databasemigratie toe te passen met het onderstaande commando:<\/li>\n<\/ol>\n
- Kopieer de .env<\/strong> referenties van de database van je app en werk ze bij met de externe referenties in de schermafbeelding hieronder:<\/li>\n<\/ol>\n
- Zodra je je databasegegevens hebt ingevoerd, klik je op de knop Doorgaan<\/strong> om het proces af te ronden.<\/li>\n<\/ol>\n
- Klik in de lijst Dienst toevoegen<\/strong> op Database<\/strong> en configureer de parameters om je database-instantie te starten:<\/li>\n<\/ol>\n
- Navigeer naar het dashboard van je MyKinsta account en klik op de knop Dienst toevoegen<\/strong>:<\/li>\n<\/ol>\n
- Bezoek de URL om te bevestigen dat de Laravel welkomstpagina verschijnt:<\/li>\n<\/ol>\n
- Maak vervolgens een .env<\/strong> bestand aan in de hoofdmap van het project en kopieer de inhoud van .env.example<\/strong> hierin.<\/li>\n
- Een actief Kinsta account<\/a><\/li>\n
- API sleutel<\/strong> – Het beperken van toegang via API sleutels houdt in dat je de aanvrager voorziet van vooraf gegenereerde API sleutels en dat je per sleutel rate limits instelt. Met deze aanpak kun je ook verschillende toegangsniveaus toepassen op de gegenereerde API sleutels.<\/li>\n