Architecture Decision RecordRikodin shawarar gine-gine: snake_case ko camelCase don REST API?
Shawara: Za a yi amfani da ƙa’idar suna ta snake_case don wuraren ƙarshe na REST API
Matsayi: An karɓa
Mahalli
A ƙa’idojin suna na REST API, akwai nau’i biyu da suka shahara: snake_case da camelCase. Tsarin snake_case shi ne inda ake raba kowace kalma a cikin suna da alamar ƙasa (underscore), yayin da camelCase shi ne inda kalmar farko ta sunan take cikin ƙananan haruffa, kuma kalmomin da suka biyo baya haruffansu na farko manya ne. Wannan shawara za ta ƙayyade ƙa’idar sunan da ya kamata a yi amfani da ita don REST API.
Abubuwan da ke Motsa Shawara
Daidaito da ƙa’idojin suna da ke akwai a aikin
Sauƙin karantawa da bayyanawa ga duk wanda zai iya aiki a kan API
Daidaito da mafi kyawun ayyukan masana’antu na ƙa’idojin suna na REST API
Sauƙin aiwatarwa da kulawa
Shawara
Za a yi amfani da ƙa’idar suna ta snake_case don wuraren ƙarshe na REST API. Waɗannan abubuwa ne suka motsa wannan zaɓi:
Daidaito: Aikin ya riga ya yi amfani da ƙa’idar suna ta snake_case don duk wuraren ƙarshe, kuma zai yi amfani a kiyaye wannan ƙa’ida don tabbatar da daidaito a duk aikin.
Sauƙin karantawa da bayyanawa: Ƙa’idar snake_case ta fi sauƙin karantawa da fahimta. Alamomin ƙasa suna ba da bayyanannen rabuwa tsakanin kalmomi, wanda ke sauƙaƙa fahimtar ma’anar sunan.
Daidaito da mafi kyawun ayyukan masana’antu: Ana amfani da ƙa’idar snake_case sosai a masana’antu kuma ana ɗaukarta mafi kyawun aiki ga REST API, wanda ya sa ta zama zaɓi mai kyau ga aikin.
Sauƙin aiwatarwa da kulawa: Ci gaba da ƙa’idar sunan da ke akwai ya fi sauƙin aiwatarwa da kulawa domin dole ne a sabunta duk lambar da takardun da ke akwai idan an zaɓi sabuwar ƙa’ida.
Sakamako
Akwai yiwuwar sakamako na wannan shawara.
Idan wasu sababbin membobin tawaga da suka shiga aikin ba su saba da ƙa’idar suna ta snake_case ba, hakan na iya haifar da ruɗani da kurakurai a ci gaba. Duk da haka, tun da snake_case ƙa’ida ce da ake amfani da ita sosai, irin wannan haɗarin ƙanƙani ne.
Idan ana amfani da wasu kayan aiki ko tsarin aiki a aikin waɗanda suka dogara sosai da ƙa’idar camelCase, hakan na iya buƙatar ƙarin ƙoƙari don sauya tsakanin ƙa’idojin suna. Duk da haka, ba damuwa ce mai girma ba domin aikin ya daidaita kan ƙa’idar snake_case.
A gaba ɗaya, shawarar amfani da ƙa’idar suna ta snake_case don wuraren ƙarshe na REST API tana haifar da hanya mai daidaito, mai sauƙin karantawa, kuma ta ma’aunin masana’antu yayin da take da sauƙin aiwatarwa da kulawa.