Architecture Decision RecordArkitekturbeslutspost: snake_case eller camelCase för ett REST-API?
Beslut: namnkonventionen snake_case kommer att användas för REST-API-slutpunkter
Tillstånd: Godkänd
Sammanhang
I namnkonventioner för REST-API:er finns två populära format: snake_case och camelCase. Formatet snake_case är där varje ord i namnet separeras med understreck, medan camelCase är där det första ordet i namnet skrivs med gemener och efterföljande ord har sin första bokstav versal. Det här beslutet avgör vilken namnkonvention som ska användas för ett REST-API.
Beslutsdrivkrafter
Konsekvens med befintliga namnkonventioner i projektet
Läsbarhet och tydlighet för alla som kan arbeta med API:et
Överensstämmelse med branschens bästa praxis för namnkonventioner för REST-API:er
Enkelhet att implementera och underhålla
Beslut
Namnkonventionen snake_case kommer att användas för REST-API-slutpunkter. Det här valet drivs av följande faktorer:
Konsekvens: Projektet använder redan namnkonventionen snake_case för alla slutpunkter, och det vore fördelaktigt att behålla den här konventionen för att säkerställa konsekvens i hela projektet.
Läsbarhet och tydlighet: Konventionen snake_case är mer läsbar och lättare att förstå. Understrecken ger en tydlig separation mellan ord, vilket gör det lättare att tolka och förstå namnets betydelse.
Överensstämmelse med branschens bästa praxis: Konventionen snake_case används brett i branschen och anses vara bästa praxis för REST-API:er, vilket gör den till ett bra val för projektet.
Enkelhet att implementera och underhålla: Att behålla den befintliga namnkonventionen är enklare att implementera och underhålla eftersom all befintlig kod och dokumentation skulle behöva uppdateras om en ny konvention valdes.
Konsekvenser
Det finns potentiella konsekvenser av det här beslutet.
Om nya teammedlemmar som går med i projektet inte är bekanta med namnkonventionen snake_case kan det leda till förvirring och misstag i utvecklingen. Eftersom snake_case är en allmänt använd konvention är en sådan risk dock minimal.
Om andra verktyg eller ramverk används i projektet som i hög grad bygger på konventionen camelCase kan det kräva extra ansträngning att konvertera mellan namnkonventioner. Det är dock inget större bekymmer eftersom projektet har standardiserat på konventionen snake_case.
Sammantaget resulterar beslutet att använda namnkonventionen snake_case för REST-API-slutpunkter i ett konsekvent, läsbart och branschstandardiserat tillvägagångssätt som samtidigt är enkelt att implementera och underhålla.