Architecture Decision RecordArkitektúrákvörðunarskrá: snake_case eða camelCase fyrir REST API?
Ákvörðun: snake_case nafnavenja verður notuð fyrir REST API endapunkta
Staða: Samþykkt
Samhengi
Í nafnavenjum fyrir REST API eru tvö vinsæl snið: snake_case og camelCase. Í snake_case er hvert orð í heitinu aðskilið með undirstrikum, en í camelCase er fyrsta orð heitisins ritað með lágstöfum og fyrsti stafur hvers eftirfarandi orðs er hástafur. Þessi ákvörðun ræður því hvaða nafnavenja skuli notuð fyrir REST API.
Drifkraftar ákvörðunar
Samræmi við núverandi nafnavenjur í verkefninu
Læsileiki og skýrleiki fyrir alla sem kunna að vinna við API
Samræmi við bestu starfsvenjur í greininni um nafnavenjur REST API
Auðveld útfærsla og viðhald
Ákvörðun
snake_case nafnavenja verður notuð fyrir REST API endapunkta. Þetta val byggir á eftirfarandi þáttum:
Samræmi: Verkefnið notar nú þegar snake_case nafnavenju fyrir alla endapunkta og gagnlegt væri að halda þeirri venju til að tryggja samræmi í öllu verkefninu.
Læsileiki og skýrleiki: snake_case venjan er læsilegri og auðveldari að skilja. Undirstrikin veita skýran aðskilnað milli orða, sem gerir auðveldara að greina og skilja merkingu heitisins.
Samræmi við bestu starfsvenjur í greininni: snake_case venjan er víða notuð í greininni og er talin vera besta starfsvenja fyrir REST API, sem gerir hana að góðum kosti fyrir verkefnið.
Auðveld útfærsla og viðhald: Að halda sig við núverandi nafnavenju er auðveldara í útfærslu og viðhaldi þar sem uppfæra þyrfti allan núverandi kóða og skjölun ef ný venja væri valin.
Afleiðingar
Þessi ákvörðun getur haft hugsanlegar afleiðingar.
Ef nýtt teymisfólk sem gengur til liðs við verkefnið þekkir ekki snake_case nafnavenjuna gæti það leitt til ruglings og mistaka í þróun. Þar sem snake_case er hins vegar víða notuð venja er slík áhætta lítil.
Ef önnur verkfæri eða rammar eru notuð í verkefninu sem byggja mjög á camelCase venjunni gæti það krafist aukinnar fyrirhafnar að umbreyta milli nafnavenja. Það er þó ekki veruleg áhyggjuefni þar sem verkefnið hefur staðlað á snake_case venjuna.
Í heildina leiðir ákvörðunin um að nota snake_case nafnavenju fyrir REST API endapunkta til samræmdrar, læsilegrar og iðnaðarstaðlaðrar nálgunar og er jafnframt auðveld í útfærslu og viðhaldi.