openapi: 3.0.3 info: title: Gebruikersbeheer API version: '1.0.0' description: | Een API voor gebruikersbeheer met uitgebreide limiet- en quota-beheermechanismen. paths: /users: get: summary: Haal een lijst van gebruikers op security: - OAuth2: [read] responses: '200': description: Een lijst van gebruikers '429': description: Te veel aanvragen (throttling limiet overschreden) headers: Retry-After: description: Tijd in seconden voordat opnieuw geprobeerd kan worden schema: type: integer components: securitySchemes: OAuth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://auth.example.com/oauth/authorize tokenUrl: https://auth.example.com/oauth/token scopes: read: Leesrechten voor gebruikersgegevens write: Schrijfrechten voor gebruikersgegevens x-throttling: description: > Begrenzingen voor het beperken van het aantal verzoeken binnen bepaalde tijdsperioden. burstLimit: description: Maximaal aantal verzoeken dat in een korte periode (bijvoorbeeld 1 seconde) mag worden gemaakt. type: integer default: 10 steadyStateLimit: description: Aantal verzoeken dat op de lange termijn toegestaan is (bijvoorbeeld per minuut). type: integer default: 100 x-quota: description: > Quota-beperkingen voor het gebruik van de API, zoals verzoeken per uur of dag. requestsPerHour: description: Maximaal aantal verzoeken per uur per gebruiker. type: integer default: 1000 requestsPerDay: description: Maximaal aantal verzoeken per dag per gebruiker. type: integer default: 10000 x-handhavingsmechanismen: description: > Mechanismen voor het afdwingen van limieten en het informeren van clients. statusCode429: description: > Wanneer de limiet overschreden wordt, wordt HTTP statuscode 429 geretourneerd. headers: Retry-After: description: > Geeft aan na hoeveel seconden de client het opnieuw mag proberen. schema: type: integer meldingen: description: > Mogelijke meldingen of responsgegevens die clients informeren over het overschrijden van limieten. (bijvoorbeeld body-informatie of headers) (Niet uitgeschreven voor beknoptheid) security: - OAuth2: [read, write] # Opmerking: De bovenstaande specificatie bevat de kerncomponenten voor limieten en quota-beheer, inclusief throttlingstrategieën, quota-limieten, handhavingsmechanismen en authenticatie via OAuth2. U kunt deze verder uitbreiden en aanpassen op basis van specifieke implementatiebehoeften.

{ "openapi": "3.0.0", "info": { "title": "Gebruikersbeheer API", "description": "Een API voor het beheren van gebruikers, met gedetailleerde throttling- en quota-beheerlimieten.", "version": "1.0.0" }, "servers": [ { "url": "https://api.voorbeeld.com/v1", "description": "Productieserver" } ], "paths": { "/gebruikers": { "get": { "summary": "Lijst van gebruikers ophalen", "description": "Haalt een lijst van alle gebruikers op, met throttling en quota-beheer.", "security": [ { "OAuth2": [] } ], "responses": { "200": { "description": "Succesvolle reactie met lijst van gebruikers" }, "429": { "description": "Te veel verzoeken - throttling of quota limiet overschreden" } }, "x-throttling": { "burstLimit": 100, "steadyStateLimit": 10, "timeUnit": "minute" }, "x-quota": { "requestsPerHour": 1000, "requestsPerDay": 10000 } }, "post": { "summary": "Nieuwe gebruiker aanmaken", "description": "Maakt een nieuwe gebruiker aan, met throttling en quota-beheer.", "security": [ { "OAuth2": [] } ], "responses": { "201": { "description": "Gebruiker succesvol aangemaakt" }, "429": { "description": "Te veel verzoeken - throttling of quota limiet overschreden" } }, "x-throttling": { "burstLimit": 50, "steadyStateLimit": 5, "timeUnit": "minute" }, "x-quota": { "requestsPerHour": 500, "requestsPerDay": 5000 } } }, "/gebruikers/{id}": { "get": { "summary": "Specifieke gebruiker ophalen", "description": "Haalt details op van een specifieke gebruiker, met throttling en quota-beheer.", "security": [ { "OAuth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Succesvolle reactie met gebruikersdetails" }, "429": { "description": "Te veel verzoeken - throttling of quota limiet overschreden" } }, "x-throttling": { "burstLimit": 200, "steadyStateLimit": 20, "timeUnit": "minute" }, "x-quota": { "requestsPerHour": 2000, "requestsPerDay": 20000 } } } }, "components": { "securitySchemes": { "OAuth2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://api.voorbeeld.com/oauth/token", "scopes": { "gebruikers.lezen": "Toegang om gebruikers te lezen", "gebruikers.schrijven": "Toegang om gebruikers te schrijven" } } } } }, "responses": { "ThrottlingError": { "description": "Throttling fout - te veel verzoeken", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Te veel verzoeken" }, "message": { "type": "string", "example": "Quota limiet overschreden. Probeer het later opnieuw." }, "retryAfter": { "type": "integer", "example": 60 } } } } } } } }, "x-throttling-enforcement": { "mechanism": "Retourneer statuscode 429 met Retry-After header en gedetailleerde foutmelding", "notifications": "Stuur een waarschuwing naar beheerders bij herhaalde overtredingen" }, "x-quota-enforcement": { "mechanism": "Houd quota bij per OAuth2 client en gebruiker, retourneer 429 bij overschrijding", "resetPolicy": "Uur- en daglimieten resetten op basis van UTC-tijd" } }