Hoofdinhoud
In het kader van het beheer en de doorontwikkeling van de API Design Rules brengt Logius een nieuwe versie uit. De voorgestelde release bevat normatieve en niet-normatieve wijzigingen in het core document van de standaard. Via deze consultatie nodigen wij u uit om feedback te geven op het voornemen tot doorvoering van deze wijzigingen. De consultatie loopt tot 21 juli 2025.
API Design Rules
De API Design Rules (ADR) zijn de Nederlandse overheidsstandaard voor het ontwerpen van API’s. Ze beschrijven op uniforme wijze hoe API-specificaties opgebouwd moeten zijn, zodat deze herbruikbaar, begrijpelijk en veilig zijn voor zowel ontwikkelaars als afnemers binnen de overheid.
Wijzigingen
De API Design Rules zijn op de volgende punten aangepast:
Normatieve wijziging:
- Het veld info.contact in het openapi.json-bestand moet verplicht volledig worden ingevuld.
Niet-normatieve wijzigingen:
- Integratie van de Transport Security module: in plaats van een losse verwijzing zijn de relevante regels nu opgenomen in het core document. Bepaalde moduleregels zijn samengevoegd met bestaande regels in het core document.
- Vervangen van validatorverwijzingen: technische verwijzingen naar een validator zijn vervangen door tekstuele testinstructies.
- Opschoning van de regelstructuur: de onderdelen "Implications" en "How to test" zijn samengevoegd voor meer duidelijkheid.
- Toevoeging van Spectral linter: een configuratiebestand voor Spectral is als bijlage toegevoegd. Deze linter maakt deel uit van de implementatieondersteuning vanuit beheer bij Logius.
Consultatie
Reageren kan tot 21 juli 2025 via api@logius.nl of via een issue of Pull Request via Github. Uw input helpt ons om de inhoud, planning en communicatie zo goed mogelijk af te stemmen op de praktijk. De consultatieversie is beschikbaar als API Design Rules 2.1 release candidate 1.
Meer informatie
Meer informatie over de API Design Rules vindt u in de werkversie. Meer informatie over de consultaties van onze standaarden vindt u op onze Github repository.