Architecture Decision Record

Active theme: Light

← முடிவு பதிவு எடுத்துக்காட்டுகள்

கட்டமைப்பு முடிவு பதிவு: REST API க்கு snake_case அல்லது camelCase?

முடிவு: REST API இறுதிப்புள்ளிகளுக்கு snake_case பெயரிடல் மரபு பயன்படுத்தப்படும்

நிலை: ஏற்கப்பட்டது

சூழல்

REST API களுக்கான பெயரிடல் மரபுகளில் இரண்டு பிரபலமான வடிவங்கள் உள்ளன: snake_case மற்றும் camelCase. snake_case வடிவத்தில் பெயரில் உள்ள ஒவ்வொரு சொல்லும் அடிக்கோடுகளால் பிரிக்கப்படும், camelCase இல் பெயரின் முதல் சொல் சிற்றெழுத்தில் இருக்கும், அடுத்தடுத்த சொற்களின் முதல் எழுத்து பேரெழுத்தில் இருக்கும். இந்த முடிவு REST API க்கு எந்தப் பெயரிடல் மரபைப் பயன்படுத்த வேண்டும் என்பதைத் தீர்மானிக்கும்.

முடிவுக்கான உந்து காரணிகள்

  • திட்டத்தில் உள்ள பெயரிடல் மரபுகளுடன் நிலைத்தன்மை

  • API இல் பணியாற்றக்கூடிய எவருக்கும் படிக்கும் தன்மையும் தெளிவும்

  • REST API பெயரிடல் மரபுகளுக்கான தொழில் சிறந்த நடைமுறைகளுடன் ஒத்திசைவு

  • நடைமுறைப்படுத்தல் மற்றும் பராமரிப்பின் எளிமை

முடிவு

REST API இறுதிப்புள்ளிகளுக்கு snake_case பெயரிடல் மரபு பயன்படுத்தப்படும். இந்தத் தேர்வு பின்வரும் காரணிகளால் இயக்கப்படுகிறது:

  1. நிலைத்தன்மை: திட்டம் ஏற்கனவே அனைத்து இறுதிப்புள்ளிகளுக்கும் snake_case பெயரிடல் மரபைப் பயன்படுத்துகிறது, முழுத் திட்டத்திலும் நிலைத்தன்மையை உறுதிசெய்ய இந்த மரபைப் பராமரிப்பது நன்மை பயக்கும்.

  2. படிக்கும் தன்மையும் தெளிவும்: snake_case மரபு மிகவும் படிக்கக்கூடியது, புரிந்துகொள்ள எளிதானது. அடிக்கோடுகள் சொற்களுக்கு இடையே தெளிவான பிரிப்பை வழங்குகின்றன, பெயரின் பொருளைப் பகுப்பாய்வு செய்து புரிந்துகொள்வதை எளிதாக்குகின்றன.

  3. தொழில் சிறந்த நடைமுறைகளுடன் ஒத்திசைவு: snake_case மரபு தொழில்துறையில் பரவலாகப் பயன்படுத்தப்படுகிறது, REST API களுக்குச் சிறந்த நடைமுறையாகக் கருதப்படுகிறது, இது திட்டத்துக்கு நல்ல தேர்வாகிறது.

  4. நடைமுறைப்படுத்தல் மற்றும் பராமரிப்பின் எளிமை: இருக்கும் பெயரிடல் மரபைப் பின்பற்றுவது நடைமுறைப்படுத்தவும் பராமரிக்கவும் எளிதானது, ஏனெனில் புதிய மரபு தேர்ந்தெடுக்கப்பட்டால் இருக்கும் அனைத்துக் குறியீடும் ஆவணங்களும் புதுப்பிக்கப்பட வேண்டும்.

விளைவுகள்

இந்த முடிவுக்குச் சாத்தியமான விளைவுகள் உள்ளன.

  • திட்டத்தில் சேரும் புதிய குழு உறுப்பினர்கள் snake_case பெயரிடல் மரபுக்குப் பரிச்சயமில்லாதவர்களாக இருந்தால், அது மேம்பாட்டில் குழப்பத்துக்கும் தவறுகளுக்கும் வழிவகுக்கலாம். இருப்பினும், snake_case என்பது பரவலாகப் பயன்படுத்தப்படும் மரபு என்பதால், அத்தகைய ஆபத்து குறைவு.

  • திட்டத்தில் camelCase மரபை அதிகம் சார்ந்த பிற கருவிகள் அல்லது கட்டமைப்புகள் பயன்படுத்தப்பட்டால், பெயரிடல் மரபுகளுக்கு இடையே மாற்ற கூடுதல் முயற்சி தேவைப்படலாம். இருப்பினும், திட்டம் snake_case மரபில் தரப்படுத்தியுள்ளதால் இது குறிப்பிடத்தக்க கவலை இல்லை.

ஒட்டுமொத்தமாக, REST API இறுதிப்புள்ளிகளுக்கு snake_case பெயரிடல் மரபைப் பயன்படுத்தும் முடிவு, நடைமுறைப்படுத்தவும் பராமரிக்கவும் எளிதாக இருக்கும் அதே வேளையில், நிலையான, படிக்கக்கூடிய, தொழில்-தரமான அணுகுமுறையை விளைவிக்கிறது.

நன்றி: இந்தப் பக்கம் ChatGPT ஆல் உருவாக்கப்பட்டு, தெளிவு மற்றும் வடிவமைப்புக்காகத் திருத்தப்பட்டது.