Architecture Decision RecordTaifead Cinnidh Ailtireachta: snake_case nó camelCase le haghaidh API REST?
Cinneadh: úsáidfear coinbhinsiún ainmniúcháin snake_case do chríochphointí API REST
Stádas: Glactha
Comhthéacs
I gcoinbhinsiúin ainmniúcháin do APInna REST, tá dhá fhormáid choitianta ann: snake_case agus camelCase. Is é snake_case an fhormáid ina scartar gach focal san ainm le fostríceanna, agus is é camelCase an fhormáid ina bhfuil an chéad fhocal den ainm i litreacha beaga, agus tá ceannlitir ar an gcéad litir de na focail ina dhiaidh. Cinnfidh an cinneadh seo cén coinbhinsiún ainmniúcháin ba cheart a úsáid d'API REST.
Tiomántóirí Cinnidh
Comhsheasmhacht leis na coinbhinsiúin ainmniúcháin atá ann cheana sa tionscadal
Inléiteacht agus soiléireacht do dhuine ar bith a bhféadfadh sé a bheith ag obair ar an API
Ailíniú le dea-chleachtais an tionscail do choinbhinsiúin ainmniúcháin API REST
Éascaíocht cur chun feidhme agus cothabhála
Cinneadh
Úsáidfear coinbhinsiún ainmniúcháin snake_case do chríochphointí API REST. Is iad na fachtóirí seo a leanas a threoraigh an rogha seo:
Comhsheasmhacht: Úsáideann an tionscadal coinbhinsiún ainmniúcháin snake_case cheana do gach críochphointe, agus bheadh sé tairbheach an coinbhinsiún seo a choinneáil chun comhsheasmhacht a chinntiú ar fud an tionscadail iomláin.
Inléiteacht agus soiléireacht: Tá an coinbhinsiún snake_case níos inléite agus níos éasca le tuiscint. Soláthraíonn na fostríceanna deighilt shoiléir idir focail, rud a fhágann go bhfuil sé níos éasca brí an ainm a pharsáil agus a thuiscint.
Ailíniú le dea-chleachtais an tionscail: Úsáidtear an coinbhinsiún snake_case go forleathan sa tionscal agus meastar gur dea-chleachtas é d'APInna REST, rud a fhágann gur rogha mhaith é don tionscadal.
Éascaíocht cur chun feidhme agus cothabhála: Tá sé níos éasca an coinbhinsiún ainmniúcháin atá ann cheana a choinneáil a chur i bhfeidhm agus a chothabháil mar bheadh ar gach cód agus doiciméadú atá ann cheana a bheith nuashonraithe dá roghnófaí coinbhinsiún nua.
Iarmhairtí
Tá iarmhairtí féideartha leis an gcinneadh seo.
Má tá baill fhoirne nua a thagann isteach sa tionscadal anaithnid leis an gcoinbhinsiún ainmniúcháin snake_case, d'fhéadfadh mearbhall agus botúin a bheith mar thoradh air san fhorbairt. Mar sin féin, ós rud é gur coinbhinsiún a úsáidtear go forleathan é snake_case, tá a leithéid de riosca íosta.
Má úsáidtear uirlisí nó creataí eile sa tionscadal atá bunaithe go mór ar choinbhinsiún camelCase, d'fhéadfadh iarracht bhreise a bheith ag teastáil chun iompú idir coinbhinsiúin ainmniúcháin. Mar sin féin, ní imní shuntasach é mar go bhfuil an tionscadal caighdeánaithe ar an gcoinbhinsiún snake_case.
Ar an iomlán, is é toradh an chinnidh coinbhinsiún ainmniúcháin snake_case a úsáid do chríochphointí API REST ná cur chuige comhsheasmhach, inléite, caighdeánach don tionscal agus é éasca a chur i bhfeidhm agus a chothabháil.