developer.overheid.nl

Ontwikkelaarsportaal van de Nederlandse overheid

Ga naar hoofdinhoud

OpenAPI Specification (OAS)

Verplichte standaard

Deze standaard is verplicht voor REST API's van de overheid. Let op: momenteel wordt alleen OAS versie 3.0.x goedgekeurd.

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: OpenAPI Spec 3.0.