Hoe te voldoen
Onderstaande technische regels kunnen automatisch gecontroleerd worden met de ADR Linter. Voor deze regels zijn er tips en codevoorbeelden beschikbaar om API's te laten slagen. Let op: dit zijn niet álle API Design Rules. Kijk voor een volledig overzicht van de regels in de repository van de standaard op https://gitdocumentatie.logius.nl/publicatie/api/adr/.
/core/doc-openapi-contact
Deze regel schrijft voor dat je contactinformatie in OAS moet opnemen voor
/core/doc-openapi
Deze regel schrijft voor dat REST API's van de overheid beschreven moeten worden
/core/http-methods
Deze regel schrijft voor dat alleen de standaard HTTP methods GET, POST,
/core/no-trailing-slash
Deze regel schrijft voor dat een path geen trailing slash mag bevatten, met
/core/publish-openapi
Deze regel schrijft voor dat elke api een /openapi.json file moet publiceren
/core/semver
Deze regel schrijft voor dat versionering van API's via Semantic Versioning
/core/uri-version
Deze regel schrijft voor dat de major versie, voorafgegaan door de letter v,
/core/version-header
Deze regel schrijft voor dat iedere API response een API-Version response