API: consolidatie en schoonmaak

[BasLee]

Broccoli draait nu in productie in een grotendeels ongeteste toestand.
Door de experimentele staat van het omringende IT-landschap moest de interne structuur van broccoli in de loop der jaren een aantal keer over de kop.

Hierdoor is de 'technical dept' opgelopen:

• Tests die er waren, die werken niet meer of zijn geschrapt
• Veel logica in de resources die eigenlijk in aparte services horen
• Het configuratieschema heeft last van wildgroei en een gebrek aan 'sensible defaults'

Om de technical dept aan te pakken:

• bestaande functionaliteit goed testen
• services introduceren om logica uit de resources in 'leesbare' abstracties te vangen
• opschonen van configuratieschema, en een config template met defaults introduceren?

Daarnaast moet de API van broccoli zowel stabiel blijven als toekomstige veranderen aankunnen. Om dit te ondersteunen kunnen we de API versioneren:

• /v1: huidige api: enkel refactorwerk en bugfixes
• /v2 schema: toekomstige verwijderingen, aanpassingen en uitbreidingen van de endoints