Nieuw API-Register overheid zet in op REST-Only en OpenAPI-First

De keuze voor REST-only betekent dat het merendeel van de bestaande API's (REST/JSON en REST/XML) wordt samengevoegd tot één "REST"-cluster. Ook OData API's en de modernere OGC API's voor geoservices, die steeds vaker traditionele standaarden als WFS en WMS vervangen, worden hierin opgenomen. Uitzonderingen zoals GraphQL, CKAN, Atom en Socrata zullen voorlopig geen plaats meer krijgen in het register, om de flexibiliteit van het systeem te maximaliseren voor de dominante API-types.

De OpenAPI-first benadering houdt in dat de OpenAPI Specification (OAS) de primaire bron van informatie wordt voor alle API's in het register. Dit maakt maximaal gebruik van de uitgebreide tooling die beschikbaar is voor OpenAPI. Essentiële metadata zoals naam, omschrijving, contactgegevens, authenticatie, omgevingen en documentatie-URL's zullen direct uit de OAS worden gehaald.

Een belangrijke verandering is de koppeling met organisaties. Deze zal voortaan via API-credentials verlopen, waardoor de verantwoordelijkheid voor het beheer van API's direct bij de aanbiedende organisatie komt te liggen. Organisaties die voorkomen in het Register van Overheidsorganisaties (ROO) zullen worden gekoppeld aan TOOI (Thesauri en Ontologieën voor Overheidsinformatie) voor betere vindbaarheid en interoperabiliteit.

SDK

Het nieuwe API-register hanteert tevens een API-first benadering voor zijn eigen functionaliteit, wat automatische synchronisatie met CI/CD pipelines en de ontwikkeling van eigen front-ends mogelijk maakt. Nieuwe features omvatten het tonen van de API-lifecycle status (Active, Deprecated, Sunset, Retired) via specifieke OAS-extensies, de mogelijkheid om te abonneren op API-wijzigingen, en integratie met een Discourse forum voor communicatie tussen gebruikers en aanbieders. Toekomstige plannen omvatten ondersteuning voor OpenAPI 3.1, automatische generatie van SDK's, mocking, thematisering, en geavanceerde ADR-scores.

Organisaties die geïnteresseerd zijn in het testen van het nieuwe API-register worden uitgenodigd contact op te nemen met developer.overheid@geonovum.nl.