Overkoepelende API-functionaliteiten

Auteur: Joeri Bekker | Status: CONCEPT

Het wordt steeds duidelijker dat verschillende API's idealiter grotendeels hetzelfde moeten werken. In praktische zin is hiertoe het open source Open API framework (OAf) ontwikkeld. Het OAf wordt nu gebruikt voor nieuwe API's en bestaande API's worden doorontwikkeld om het OAf te gebruiken.

Het OAf wordt op dit moment gebruikt in de registratie-componenten: Open Zaak, Open Klant, Objecten API, Objecttypen API, Open Notificaties en de Referentielijsten API.

Het OAf leunt weer op frameworks en andere libraries (afhankelijkheden), die via OAf bij elkaar komen, waardoor in alle API's dezelfde versie van deze afhankelijkheden worden gebruikt en dezelfde functies beschikbaar komen.

Hieronder staat een niet-uitputtende lijst van modules en/of functionaliteiten in het OAf. Omdat er soms vragen komen over bepaalde functies die niet in OAf zitten, zijn ook functies opgenomen die er expliciet niet in zitten.

Module / Functie	Zit in OAf?	Standaard gedrag
API-specificatie	Ja	OAS 3.1
API CRUD endpoints	Ja	Elke resource uit het informatiemodel een eigen endpoint.
API "expand"-functie	Ja	Geen (behoeft specificatie)
Autorisaties	Ja	API-token (lees/schrijf)
Notificaties	Ja	Geen (behoeft specificatie)
Handeling gedreven endpoints	Nee	Maatwerk (behoeft specificatie)
Convenience endpoints	Nee	Maatwerk (behoeft specificatie)
CI patronen	Ja	-
Configuratie via environment-variabelen	Ja (in ontwikkeling)	Alles
Documentatie environment-variabelen	Ja (in ontwikkeling)	Alles
Beheer UI	Ja	Basaal CRUD-beheer
Beheer inloggen met OIDC	Ja	-
Koppeling van services	Ja	Deels maatwerk