Architecture Decision RecordÎnregistrare a deciziei de arhitectură: snake_case sau camelCase pentru un API REST?
Decizie: Pentru endpoint-urile API REST se va folosi convenția de denumire snake_case
Stare: Acceptată
Context
În convențiile de denumire pentru API-urile REST există două formate populare: snake_case și camelCase. În formatul snake_case fiecare cuvânt din nume este separat prin liniuțe de subliniere, în timp ce în camelCase primul cuvânt al numelui este scris cu litere mici, iar cuvintele următoare au prima literă majusculă. Această decizie va stabili ce convenție de denumire trebuie folosită pentru un API REST.
Factori de decizie
Consecvența cu convențiile de denumire existente în proiect
Lizibilitate și claritate pentru oricine ar putea lucra la API
Alinierea la bunele practici din industrie pentru denumirea API-urilor REST
Ușurința implementării și întreținerii
Decizie
Pentru endpoint-urile API REST se va folosi convenția de denumire snake_case. Această alegere este determinată de următorii factori:
Consecvență: Proiectul folosește deja convenția de denumire snake_case pentru toate endpoint-urile și ar fi benefic să păstrăm această convenție pentru a asigura consecvența în întregul proiect.
Lizibilitate și claritate: Convenția snake_case este mai lizibilă și mai ușor de înțeles. Liniuțele de subliniere oferă o separare clară între cuvinte, ceea ce ușurează analizarea și înțelegerea sensului numelui.
Alinierea la bunele practici din industrie: Convenția snake_case este larg folosită în industrie și este considerată o bună practică pentru API-urile REST, ceea ce o face o alegere bună pentru proiect.
Ușurința implementării și întreținerii: Păstrarea convenției de denumire existente este mai ușor de implementat și de întreținut, deoarece tot codul și toată documentația existente ar trebui actualizate dacă s-ar alege o convenție nouă.
Consecințe
Această decizie are consecințe potențiale.
Dacă membri noi ai echipei care se alătură proiectului nu sunt familiarizați cu convenția de denumire snake_case, aceasta ar putea duce la confuzie și greșeli în dezvoltare. Totuși, deoarece snake_case este o convenție larg folosită, un astfel de risc este minim.
Dacă în proiect sunt folosite alte instrumente sau framework-uri bazate în mare măsură pe convenția camelCase, poate fi necesar un efort suplimentar pentru conversia între convențiile de denumire. Totuși, nu este o preocupare semnificativă, deoarece proiectul s-a standardizat pe convenția snake_case.
În ansamblu, decizia de a folosi convenția de denumire snake_case pentru endpoint-urile API REST are ca rezultat o abordare consecventă, lizibilă și conformă standardului din industrie, fiind în același timp ușor de implementat și de întreținut.