De status van dit document is voorlopig en zou nog kunnen wijzigen.

Schrijfwijzen van artefacten

Inleiding

Consistent gebruik van naamgevingsconventies zoals camelcasing of hyphens in API endpoints verhoogt de leesbaarheid en voorspelbaarheid, waardoor ontwikkelaars sneller en met minder fouten kunnen werken. Het vermindert de kans op typefouten en maakt het gemakkelijker om code en documentatie te begrijpen en onderhouden. Bovendien zorgt consistentie voor een professionelere uitstraling van de API, wat bijdraagt aan het vertrouwen van gebruikers en de adoptie ervan.

Afspraken

We gebruiken in de Proof of Concept van de volgende conventies voor schrijfwijzen:

• Voor ObjectTypen gebruiken we UpperCamelCase.
• Voor attribuutTypen gebruiken we lowerCamelCase.
• Voor endpoints gebruiken we kebab-case.
• Afkortingen worden als woorden behandeld. (Dus bij objectype: WozObject en attribuuttype: wozObjectnummer)