/core/doc-openapi
Deze regel schrijft voor dat REST API's van de overheid beschreven moeten worden
Ontwikkelaarsportaal van de Nederlandse overheid
Application Programming Interface
Laat alle tags zienDeze regel schrijft voor dat REST API's van de overheid beschreven moeten worden
Deze regel schrijft voor dat je contactinformatie in OAS moet opnemen voor
Deze regel schrijft voor dat alleen de standaard HTTP methods GET, POST,
Deze regel schrijft voor dat een path geen trailing slash mag bevatten, met
Deze regel schrijft voor dat elke api een /openapi.json file moet publiceren
Deze regel schrijft voor dat versionering van API's via Semantic Versioning
Deze regel schrijft voor dat de major versie, voorafgegaan door de letter v,
Deze regel schrijft voor dat iedere API response een API-Version response
In deze stap gebruiken we de
Nu we een boilerplate OAS hebben, kunnen we deze gaan uitbreiden voor onze
Nu we de schemas hebben toegevoegd, kunnen we functionaliteit gaan toevoegen.
Voordat we code gaan genereren, is het belangrijk om te controleren of onze
Nu we een gevalideerde OpenAPI Specification hebben, kunnen we automatisch
Het actuele en uitgebreide overzicht van de REST API Design Rules vind je hier:
De ADR Linter controleert of een OpenAPI Specificatie compliant is met de API
De API Design Rules (ADR) Validator is een CLI-tool om te valideren of een API
Deze standaard is
De digitale samenleving vraagt om snelheid en actualiteit. Burgers willen live
Problem JSON (application/problem+json) is een krachtige standaard voor het
Onderstaande technische regels kunnen automatisch gecontroleerd worden met de
Maps.developers.amsterdam biedt een collectie demo's en code-examples van hoe je
Van intake tot verplichte standaard
Deze tool is enkel bedoeld om je op weg te helpen met het API design, inclusief
Deze standaard is
Het kan voorkomen dat er verschillende clients gelijktijdig dezelfde bestaande
Bij een schrijfoperatie kan het voor een client onduidelijk zijn of deze is
Steeds meer overheidsorganisaties bouwen API’s om data en processen beschikbaar
<Author