Bouw een API
Hier leggen we uit welke stappen je kunt doorlopen om snel en efficiënt een nieuwe REST API te ontwikkelen. We gaan hierbij uit van een design first aanpak, dus we starten met het API design.
Eén plek voor developers die voor of met de overheid ontwikkelen
OpenAPI Specification related docs
Laat alle tags zienHier leggen we uit welke stappen je kunt doorlopen om snel en efficiënt een nieuwe REST API te ontwikkelen. We gaan hierbij uit van een design first aanpak, dus we starten met het API design.
Een OpenAPI Specificatie (OAS) is een YAML of JSON bestand met de eigenschappen van de data die een REST API als input accepteert en als output teruggeeft. Een OpenAPI Specificatie beschrijft niet hoe een API geïmplementeerd is, en heeft dus geen binding met specifieke programmeertalen.
De OAS Generator genereert een OAS boilerplate op basis van minimale configuratie. Het resultaat is een YAML of JSON template wat gebruikt kan worden om het API design verder in te vullen.
Deze standaard is verplicht voor REST API's van de overheid. Let op: momenteel wordt alleen OAS versie 3.0.x goedgekeurd.