OpenAPI is een gestandaardiseerd, machineleesbaar specificatieformaat dat de structuur en mogelijkheden van HTTP API's in JSON of YAML beschrijft. Het is voortgekomen uit de Swagger-specificatie, die in 2015 aan de Linux Foundation werd overgedragen en omgedoopt tot OpenAPI.
Een OpenAPI-document definieert alles over een HTTP API: servers en basis-URL's, endpoints en operaties (GET, POST, PUT, DELETE, enz.), verzoekparameters, request- en response-body-schema's (met JSON Schema), HTTP-statuscodes en authenticatie-/beveiligingsschema's. De specificatie is programmeertaalonafhankelijk en kan versiebeheert naast je code worden gehouden.
De kernwaarde van automatisering komt voort uit tooling die één OpenAPI-document verbruikt om meerdere artefacten automatisch te genereren zonder handmatig werk: interactieve API-documentatie (Swagger UI, Redoc), client-SDK's, server stubs, mock servers en contract tests. Dit betekent dat één bron-van-waarheid-spec downstream documentatie, codegeneratie en testen aandrijft—wat drift en onderhoudsoverhead verkleint.
OpenAPI vereist niet dat je bestaande API's herschrijft. In plaats daarvan beschrijf je je API's werkelijke mogelijkheden in de OpenAPI-structuur. Tools als OpenAPI Generator, Postman en aangepaste scripts bouwen vervolgens alles uit die beschrijving.
TipBegin met een eenvoudig OpenAPI-document dat je huidige endpoints beschrijft, laat tooling dan docs en SDK-generatie afhandelen—dit onthult doorgaans hiaten in je API-ontwerp voordat ze gebruikers beïnvloeden.
OpenAPI werkt goed samen met REST API-ontwerp en infrastructuurautomatisering, waardoor teams API's consistent kunnen documenteren, testen en implementeren.
Gerelateerde termen
Nieuwe artikelen, rechtstreeks in je inbox
Ik ontvang graag productupdates en nieuwe artikelen van InfraNest per e-mail. Ik kan me op elk moment afmelden. Privacyverklaring