Nieuwe versie (2.0) NLGov REST API Design Rules verplichten (voor betere gegevensuitwisseling)

Reactie

Naam	Anoniem
Plaats	Utrecht
Datum	18 juli 2025

Vraag1

Geef hier indien gewenst uw reactie op het advies van de experts om versie 2.0 van NLGov REST API Design Rules te verplichten aan de overheid (‘Pas toe of leg uit’) via plaatsing op de 'Pas toe of leg uit'-lijst van Forum Standaardisatie (hoofdstuk 1 van het expertadvies).

ik vind het raar om iets te verplichten dat als doel heeft, quote:
The primary goal is to offer guidance for organizations designing new APIs, with the purpose of increasing developer experience (DX) and interoperability between APIs. Hopefully, many organizations will adopt these design rules in their corporate API strategies and provide feedback about exceptions and additions to subsequently improve these design rules.

mij lijkt het met dat doel een richtlijn, welk advies in eerste instantie staat en om gegronde redenen van af geweken kan worden. Dat lijkt me de facto in 'pas toe of leg uit' vallen, maar als ik geïntroduceerd wordt waar ik aan moet verplichten, vat ik dat als implementerende partij wel anders op dan een richtlijn.

Vraag2

Geef hier indien gewenst uw reactie op het geformuleerde nut en de geformuleerde mogelijkheden van het gebruik van NLGov REST API Design Rules voor en door de overheid (hoofdstuk 2, paragraaf 2 van het expertadvies).

ik mis goede nummering op de regels in het document, welke discussie bij bijvoorbeeld een implementatie of over uitbreiding/verandering van de regels vergemakkelijken. Vergelijk het bijvoorbeeld met de regels in de WCAG: https://www.w3.org/TR/WCAG21/

Ook vind ik de overlap tussen hoofdstuk 2 en 3 zo onhandig.

Vraag3

Geef hier indien gewenst uw reactie op het doorlopen proces van het expertadvies (hoofdstuk 3 van het expertadvies).

er wordt slechts gericht feedback gevraagd in deze documenten, waardoor er geen ruimte is en niet wordt gezocht naar feedback die vanuit andere perspectieven kan komen die niet pas binnen de kaders waarin de opstellende partij denkt. Ook is het feedbackproces sterk gericht op het proces en de nota, en minder om de standaard.

Vraag4

Geef hier indien gewenst uw reactie op de samenstelling van de expertgroep (hoofdstuk 4 van het expertadvies).

deze heb ik niet kunnen vinden, ik heb vooral gekeken naar https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0/ waar deze niet in staat in hoofdstuk 4. Mij is verteld dat dit daarvoor het feedbackformulier is, uiteraard excuses als dit de verkeerde plek is.

oh dit gaat over de nota over de standaard, inmiddels heb ik deze gevonden. Ik kan me voorstellen dat het kan werken om hier academia (beperkt) in te betrekken, zoals aan iig de TU/e, waarschijnlijk ook TU Delft, UT, en de hogescholen met informatica opleidingen.

Vraag5

Geef hier indien gewenst uw reactie op de resultaten van de toetsing op hoofdlijnen van hoofdcriterium “Toegevoegde waarde” (hoofdstuk 5, paragraaf 1 van het expertadvies).

Meeste richtlijnen die in de standaard staan kan ik me ook in vinden, zijn logische principes in API design, implementatie, en documentatie

het is alleen niet duidelijk wanneer een endpoint hier onder valt, en dat lijkt me juist handig, ik verwacht dat niet alle endpoints in alle solutions en organisaties/projecten die er zijn gemakkelijk in dezelfde mal passen. Mogelijk wordt er om begrijpelijke redenen soms teruggegrepen op SOAP, of wordt er gebruik gemaakt van websockets vanuit de specieke werking daarvan die nodig is.

Ik mis in de standaard ook een ingangspunt voor feedback, dat staat niet beschreven in deze standaard, en ik zie ook niet makkelijk daar een referentie voor. Vaak kunnen voor standaarden die adhv github ontwikkeld worden, feedback wordt dan vaak verzameld adhv issues op de repo, dat zorgt voor meer open standaarden die makkelijker feedback vanuit het werkveld integreren en zo ondersteuning bieden.

Vraag6

Geef hier indien gewenst uw reactie op de resultaten van de toetsing op hoofdlijnen van hoofdcriterium “Open standaardisatieproces” en op het advies om aan Logius het predicaat 'Uitstekend beheer' toe te kennen voor NLGov REST API Design Rules (hoofdstuk 5, paragraaf 2 van het expertadvies).

hier werd ik verrast door het feit dat er ineens nog een tweede pagina aan feedback velden zijn, en helaas heb ik niet de tijd om deze ook nog in te vullen.
Ja dit lag deels bij mij zie ik nu, dat er wel steeds 6 van 10 staat, maar ik heb helaas ook andere verplichtingen en het geven van feedback is al lastig zat, vanwege de gerichtheid en de dubbele laag dat ik alleen feedback op de standaard kan geven door vragen op de nota te beantwoorden.