Eén centrale plek voor de developer die voor of met de overheid ontwikkelt
Hier leggen we uit welke stappen je kunt doorlopen om snel en efficient een nieuwe REST API te ontwikkelen. We gaan hierbij uit van een design first aanpak, dus we starten met het API design.
Open Source werken heeft veel voordelen. Maar hoe ziet de codebase van een gezond Open Source project er uit? En waar moet je nog meer rekening mee houden? Antwoorden daarop krijg je in dit artikel.
Overheidsorganisaties ontwikkelen veel API’s om allerlei data snel en efficient te delen met andere overheidsorganisaties en andere partijen die met de overheid werken. In deze post leer je hoe je zelf deze API’s kan gebruiken.
Om een open source project inzichtelijk te maken is het belangrijk dat bepaalde metadata beschikbaar is. Hiervoor is de publiccode.yml standaard in het leven geroepen.
De OpenAPI Specification (OAS) is een open standaard om REST API’s te beschrijven.
De REST API Design Rules (ADR) schrijven voor waar een REST API van de overheid aan moet voldoen. Deze regels zijn verplicht gesteld door Forum Standaardisatie, waardoor elke overheid hieraan moet voldoen.
De security.txt standaard zorgt ervoor dat ethische hackers laagdrempelig kwetsbaarheden kunnen melden bij de eigenaar/ beheerder van een applicatie.
De OAS Generator genereert een OAS boilerplate op basis van minimale configuratie. Het resultaat is een YAML of JSON template wat gebruikt kan worden om het API design verder in te vullen.
De API Design Rules (ADR) Validator is een command line interface die gebruikt kan worden om te valideren of een API zicht gedraagt conform de NL API Strategie.
De ADR Linter controleert of een OpenAPI Specificatie compliant is met de API Design Rules. De linter is gebaseerd op het Open Source project Spectral.
Ga in gesprek met andere developers en vind hier getting started guides, tutorials en tools.
Bekijk welke API's er allemaal zijn en kom er achter hoe je jouw oplossing hier op kan laten aansluiten.
Vind bestaande repositories om bij aan te haken en ontdek wat er binnen welke organisatie beschikbaar is.