OpenAPI Specification (OAS)

De OpenAPI Specification (OAS) is een open standaard om REST API’s te beschrijven. Deze standaard is verplicht gesteld door Forum Standaardisatie, waardoor elke overheid hieraan moet voldoen, mits er een REST API ontsloten wordt.

Let op: momenteel wordt alleen OAS versie 3.0.x goedgekeurd. OAS 3.1.x is niet geheel backwards compatible en heeft de verplichte status vanuit Forum Standaardisatie derhalve (nog) niet gehaald.

Met OAS kunnen alle endpoints, responses en requests van een API gedetailleerd beschreven worden in het machine-leesbare YAML of JSON formaat. De OAS Generator genereert op basis van minimale configuratie een kant-en-klare OAS template die voldoet aan de REST API Design Rules.

OAS wordt beheerd door het OpenAPI Initiative. De volledige documentatie over de specificatie is te vinden op: https://spec.openapis.org/oas/v3.0.3.