Principe P05: Dataservice eerst
Issue: [description | ticket/issue URL]
Context en probleemstelling¶
[Beschrijf de context en de probleemstelling, bijvoorbeeld in vrije tekst in twee of drie zinnen. Wellicht wil het probleem in de vorm van een vraag positioneren.]
Beslissingsfactoren ¶
- [driver 1, e.g., a force, facing concern, …]
- [driver 2, e.g., a force, facing concern, …]
- …
Overwogen opties¶
- API First
- Dataservice eerst
- [optie 3]
- …
Besluit¶
Gekozen oplossing: "[optie 1]", omdat [rechtvaardiging. bijvoorbeeld enige optie, die voldoet aan knock out criterium desicion driver | die krachtkracht | oplost … | komt het beste naar voren (zie hieronder)].
Positieve gevolgen ¶
- [bijv. verbetering van de kwaliteit, opvolgende besluiten benodigd, ...]
- …
Negatieve Consequences ¶
- [bijv. compromis op kwaliteit, opvolgende besluiten benodigd, ...]
- …
Pros en Cons van de oplossingen ¶
API First¶
// TODO Amazon's API First journey beschrijven oid
[voorbeeld | beschrijving | verwijzen naar meer informatie | …]
- Goed, omdat [argument a]
- Goed, omdat [argument b]
- Slecht, omdat [argument c]
- …
Dataservice eerst¶
Data wordt uitsluitend dmv dataservices beschikbaar gesteld. 'Dataservice eerst' is globaal beter bekend als 'API First'. Een dataservice is namelijk een digitale, machine leesbare interface; een Application Programming Interface dus.
Voor een deel is dit een gevolg van P04: Geautomatiseerd boven handmatig. Toch is het een nieuw principe, want het geeft aan dat eerst een (technisch) contract wordt opgesteld voordat aan verdere implementatie en automatisering wordt gewerkt. Het voordeel van dit principe is dan ook dat nadat de dataservice is gedefinieerd, kunnen aanbieder en afnemer parallel ontwikkelen zonder dat de dataservice al data levert (of zelfs bestaat). Het (API) contract levert voldoende zekerheid voor beide kanten om aan de slag te gaan.
Een dataservice is méér dan alleen een API, een technische interface. Het bevat ook:
- Metadata
- Inwinningscontext; voorwaarden, grondslag en context voor ontstaan
- Gebruikscontext; voorwaarden voor hergebruik, richtlijnen voor (her)gebruik en vertaling naar andere contexten
Op basis van deze gegevens kunnen data-afnemers bepalen of voldoen aan de voorwaarden voor het (her)gebruik van een dataservice.
Voor meer informatie, zie basisconcept.
- Goed, omdat [argument a]
- Goed, omdat [argument b]
- Slecht, omdat [argument c]
- …
[optie 3]¶
[voorbeeld | beschrijving | verwijzen naar meer informatie | …]
- Goed, omdat [argument a]
- Goed, omdat [argument b]
- Slecht, omdat [argument c]
- …