Woordenlijst
Wat is OpenAPI?
OpenAPI is een open standaard om een REST-API te beschrijven: welke endpoints er zijn, welke parameters ze accepteren en wat ze teruggeven. Met een OpenAPI-specificatie kunnen ontwikkelaars en tools een API snel begrijpen en aanroepen.
OpenAPI uitgelegd
Een OpenAPI-specificatie is een bestand in JSON of YAML dat een API volledig beschrijft: de endpoints, de parameters met hun types, de mogelijke antwoorden en de manier van inloggen. De standaard heette eerder Swagger; versie 3 is nu gangbaar.
Omdat de beschrijving machineleesbaar is, kunnen tools er veel mee. Je kunt automatisch documentatie genereren, een specificatie importeren in Postman om te testen, of er code voor een client mee laten maken. Ook AI-tools en automatiseringsplatformen gebruiken OpenAPI-specificaties om te begrijpen hoe ze een API aanroepen.
Een specificatie is alleen waardevol als hij klopt met wat de API echt doet. Een specificatie die automatisch uit de API zelf wordt gegenereerd, loopt minder snel achter dan een handgeschreven document.
Voorbeeld
De ontwikkelaar van het planningssysteem van Acme Groothandel importeert de OpenAPI-specificatie in Postman. Hij ziet direct welke endpoints er zijn, welke parameters zoals vestiging en datum ze accepteren en welke velden het antwoord bevat.
OpenAPI in ENABLE
ENABLE genereert een OpenAPI-specificatie van alle gepubliceerde endpoints van de Data-API van een organisatie, met parameters, rijlimieten en de manier van authenticeren. Die specificatie deel je met de ontwikkelaar of tool die de data afneemt.
FAQ
Veelgestelde vragen
Wat is het verschil tussen OpenAPI en Swagger?
OpenAPI is de huidige naam van de standaard die eerder Swagger heette. Swagger is nu vooral de naam van een set tools rond die standaard, zoals Swagger UI.
Waarvoor gebruik je een OpenAPI-specificatie?
Om een API te documenteren, te testen in tools als Postman, automatisch clientcode te genereren of een AI-tool te laten begrijpen hoe de API werkt. Het bespaart ontwikkelaars veel uitzoekwerk.
Is OpenAPI hetzelfde als een open API?
Nee. OpenAPI is een standaard om API's te beschrijven. Een open API is een API die openbaar toegankelijk is; een API met een OpenAPI-specificatie kan prima afgeschermd zijn.
Verder lezen
- PlatformData API: je datawarehouse ontsluiten via RESTPubliceer een query als beveiligd REST-endpoint voor andere systemen en apps.Lees meer
- OplossingAI-agents in je bedrijf: begin bij veilige dataAI-agents beginnen bij veilige, beperkte toegang tot data. Zo legt ENABLE die basis.Lees meer
- PlatformInterne applicatie bouwen op je bedrijfsdataBeschrijf een app in een chat en de AI Builder bouwt hem op je eigen data (pilot). Plus al je andere apps in één hub.Lees meer
- KennisbankWoordenlijst data, AI en Power BIWat is een service principal, row-level security, een semantisch model, text-to-SQL of RAG? Korte, heldere definities van begrippen rond data, Power BI en AI.Lees meer
AI gebruiken op je eigen data. Veilig, en zonder hoofdpijn.
In een online demo laten we zien hoe ENABLE je data veilig beschikbaar maakt en hoe je erop bouwt: een app beschrijven in de AI Builder, vragen in gewone taal, dashboards en API's. En hoe wij het voor je inrichten en beheren.