API Design Rules (ADR)
Deze standaard is verplicht voor REST API's van de overheid.
De REST API Design Rules (ADR) schrijven voor waar een REST API van de overheid aan moet voldoen. Een aantal van deze regels is tijdens het API design te testen met de ADR Linter. Als een API eenmaal in productie is kan de ADR Validator gebruikt worden om bepaalde regels automatisch te valideren.
Een van de belangrijkste redenen om de API Design Rules te volgen is interoperabiliteit. API’s worden gebruikt om verschillende informatiesystemen met elkaar te laten communiceren, vaak over de grenzen van teams of organisaties heen. Door gemeenschappelijke conventies te volgen kunnen verschillende systemen, mogelijk van verschillende leveranciers, beter met elkaar communiceren omdat ze dezelfde verwachtingen hebben over de structuur en werking van de API. Dit leidt uiteindelijk tot minder maatwerk, hogere kwaliteit en betere samenwerking.
ADR Cheat Sheet
Het actuele en uitgebreide overzicht van de REST API Design Rules vind je hier: API Design Rules. Hieronder vind je echter een extract met de belangrijkste technische regels en best practices om te gebruiken tijdens het ontwerpen van een API.
ADR Linter
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.
ADR Validator
De API Design Rules (ADR) Validator is een command line interface die gebruikt kan worden om te valideren of een API zicht gedraagt conform deze delen van de NL API Strategie:
Hoe te voldoen
8 artikelen