Modellering Best Practices

Geen meerdere representaties voor identieke data

Indien er velden zijn met een basisrepresentatie is het niet gewenst dat er andere velden zijn met dezelfde informatie in een andere weergavevorm; zoals bijvoorbeeld zowel een GeoJSON geometrie als een WKT geometrie. Dit levert duplicatie op en daarmee ook de mogelijkheid op inconsistentie en verwarring. Indien andere representaties gewenst zijn kan dit in sommige gevallen automatisch geleverd worden door de API (CRS negotiation bijvoorbeeld) en in andere gevallen zal de afnemer zelf de conversie moeten doen.

Naamgeving

Voor de naamgeving van de velden wordt de camelCase notatie gebruikt. Op implementatie-niveau (bijv. Postgres) wordt dit omgezet in snake_case notatie als de meest natuurlijke manier van noteren.

Gebruik duidelijke en begrijpelijke namen voor zowel datasets, tabellen als velden. Het gaat hierbij tenslotte om het beschikbaar stellen van data in de vorm van een publieke API die afnemers liefst zonder al te veel extra uitleg moeten kunnen gebruiken.

Een paar vuistregels:

gebruik camelCase namen
gebruik geen ALL_UPPERCASE namen
gebruik volledige namen (geen afbrekingen en afkortingen)
herhaal de tabelnaam niet in de namen van de velden (dus niet container.containerNummmer, maar container.nummer)