Als VNG wil ik dat de landelijke API Design Rules automatisch gecheckt worden in de CI/CD-pipeline van de referentie-implementatie

VNG-Realisatie / gemma-zaken

Samen ontwikkelen van API's voor Zaakgericht werken

https://vng-realisatie.github.io/gemma-zaken/

Other

41 stars 26 forks source link

Als VNG wil ik dat de landelijke API Design Rules automatisch gecheckt worden in de CI/CD-pipeline van de referentie-implementatie #2143

Open HenriKorver opened 1 year ago

HenriKorver commented 1 year ago

...zodat we zeker weten dat onze API's voldoen aan de landelijke API Design Rules. Momenteel is dat namelijk niet het geval, zie #2142.

Er bestaat nu een tooltje, API Design Rules Validator, dat lokaal geïnstalleerd kan worden waardoor het eenvoudig te integreren is met de CI/CD-pipeline.

Voorheen toen de ADR Validator nog onderdeel was van het API Test Platform (https://api-test.nl) was dit vrijwel onmogelijk omdat je dan een extern platform toegang moet verlenen tot je lokale omgeving.

michielverhoef commented 1 year ago

Misschien begrijp ik het verkeerd maar een lokaal te installeren tooltje moet geintegreerd worden met de CI/CD pipeline?

Er gaat het nodige veranderen in de referentie implementaties etc. maar lokaal te installeren tooltjes gaan daar geen onderdeel van uitmaken verwacht ik. Maar misschein begrijp ik het verkeerd. @joerivrij Weet jij hier meer over?

HenriKorver commented 1 year ago

Dit tooltje is onderdeel van developer.overheid.nl waar het gebruikt wordt om API's te checken op de landelijke api design rules. Als je deze checker integreert in je eigen CI/CD-omgeving weet je van te voren dat je API voldoet aan de verplichte eisen en voorkom je een negatieve score op developer.overheid.nl.