Gebruik hoofdletters in URI?

2 reacties / 0 nieuw
Frank Samwel
Gebruik hoofdletters in URI?

Het gebruik van hoofdletters in de URIs voor APIs lijkt niet consequent te worden gebruikt.

Bijvoorbeeld /v01/conceptbesluitstuk (geen hoofdletter in de URI, later staat er conceptbesluitStuk met hoofdletter S)

Bijvoorbeeld /v01/natuurlijkPersoon (hier wel hoofdletter P in de URL)

Hebben we hiervoor een conventie (snake_case, camelCase, UpperCamelCase of koppelteken voor het aan elkaar plakken van woorden)?

Joeri Bekker

Zelf ben ik niet van CamelCase (en er is volgens mij geen wetenschappelijk uitsluitsel of CamelCase of snake_case nu beter leesbaar is) maar goed een JSON API, waar de JS voor JavaScript staat, is een wereld waar CamelCase heel gebruikelijk is.

In het DSO staat in de URI strategie (2.12) in ieder geval vrij helder omschreven hoe zij het aanpakken: Grofweg alles lowercase en gebruik van koppelteken (-) behalve bij begrippen. Maar ja, waarom "activiteit" een begrip is, en "adres" (voorbeelden in de DSO) is niet altijd even duidelijk en hangt af van de context.

Om terug te komen op de genoemde voorbeelden, zou het dus (volgens DSO) worden /v1/NatuurlijkPersoon en /v1/ConceptBesluitstuk