Architecture Decision Record

Active theme: Light

← ឧទាហរណ៍កំណត់ត្រាការសម្រេចចិត្ត

កំណត់ត្រាការសម្រេចចិត្តខាងស្ថាបត្យកម្ម៖ snake_case ប្រៀបធៀប camelCase សម្រាប់ REST API?

ការសម្រេចចិត្ត៖ អនុសញ្ញាដាក់ឈ្មោះ snake_case នឹងត្រូវបានប្រើសម្រាប់ endpoint នៃ REST API

ស្ថានភាព៖ បានទទួលយក

បរិបទ

ក្នុងអនុសញ្ញាដាក់ឈ្មោះសម្រាប់ REST API មានទម្រង់ពេញនិយមពីរ៖ snake_case និង camelCase។ ទម្រង់ snake_case គឺជាកន្លែងដែលពាក្យនីមួយៗក្នុងឈ្មោះត្រូវបានបំបែកដោយសញ្ញាគូសបន្ទាត់ក្រោម ចំណែក camelCase គឺជាកន្លែងដែលពាក្យដំបូងនៃឈ្មោះជាអក្សរតូច ហើយពាក្យបន្តបន្ទាប់មានអក្សរដំបូងជាអក្សរធំ។ ការសម្រេចចិត្តនេះនឹងកំណត់ថាតើអនុសញ្ញាដាក់ឈ្មោះណាមួយគួរត្រូវបានប្រើសម្រាប់ REST API។

កត្តាជំរុញការសម្រេចចិត្ត

  • ភាពស៊ីសង្វាក់ជាមួយអនុសញ្ញាដាក់ឈ្មោះដែលមានស្រាប់ក្នុងគម្រោង

  • ភាពងាយអាន និងភាពច្បាស់លាស់សម្រាប់នរណាម្នាក់ដែលអាចធ្វើការលើ API

  • ការតម្រឹមជាមួយការអនុវត្តល្អបំផុតរបស់ឧស្សាហកម្មសម្រាប់អនុសញ្ញាដាក់ឈ្មោះ REST API

  • ភាពងាយស្រួលនៃការអនុវត្ត និងការថែទាំ

ការសម្រេចចិត្ត

អនុសញ្ញាដាក់ឈ្មោះ snake_case នឹងត្រូវបានប្រើសម្រាប់ endpoint នៃ REST API។ ជម្រើសនេះត្រូវបានជំរុញដោយកត្តាដូចតទៅ៖

  1. ភាពស៊ីសង្វាក់: គម្រោងប្រើអនុសញ្ញាដាក់ឈ្មោះ snake_case រួចហើយសម្រាប់ endpoint ទាំងអស់ ហើយវានឹងមានប្រយោជន៍ក្នុងការរក្សាអនុសញ្ញានេះ ដើម្បីធានាភាពស៊ីសង្វាក់នៅទូទាំងគម្រោងទាំងមូល។

  2. ភាពងាយអាន និងភាពច្បាស់លាស់: អនុសញ្ញា snake_case ងាយអាន និងងាយយល់ជាង។ សញ្ញាគូសបន្ទាត់ក្រោមផ្តល់ការបំបែកច្បាស់លាស់រវាងពាក្យ ដែលធ្វើឱ្យងាយវិភាគ និងយល់អត្ថន័យនៃឈ្មោះ។

  3. ការតម្រឹមជាមួយការអនុវត្តល្អបំផុតរបស់ឧស្សាហកម្ម: អនុសញ្ញា snake_case ត្រូវបានប្រើយ៉ាងទូលំទូលាយក្នុងឧស្សាហកម្ម ហើយត្រូវបានចាត់ទុកជាការអនុវត្តល្អបំផុតសម្រាប់ REST API ដែលធ្វើឱ្យវាជាជម្រើសល្អសម្រាប់គម្រោង។

  4. ភាពងាយស្រួលនៃការអនុវត្ត និងការថែទាំ: ការរក្សាអនុសញ្ញាដាក់ឈ្មោះដែលមានស្រាប់គឺងាយស្រួលអនុវត្ត និងថែទាំជាង ដោយសារកូដ និងឯកសារដែលមានស្រាប់ទាំងអស់ត្រូវធ្វើបច្ចុប្បន្នភាព ប្រសិនបើអនុសញ្ញាថ្មីត្រូវបានជ្រើសរើស។

ផលវិបាក

មានផលវិបាកដែលអាចកើតមាននៃការសម្រេចចិត្តនេះ។

  • ប្រសិនបើសមាជិកក្រុមថ្មីណាដែលចូលរួមគម្រោងមិនស្គាល់អនុសញ្ញាដាក់ឈ្មោះ snake_case វាអាចនាំឱ្យមានការយល់ច្រលំ និងកំហុសក្នុងការអភិវឌ្ឍ។ ទោះយ៉ាងណា ដោយសារ snake_case ជាអនុសញ្ញាដែលប្រើយ៉ាងទូលំទូលាយ ហានិភ័យបែបនេះមានតិចតួចបំផុត។

  • ប្រសិនបើឧបករណ៍ ឬក្របខ័ណ្ឌផ្សេងទៀតត្រូវបានប្រើក្នុងគម្រោងដែលផ្អែកខ្លាំងលើអនុសញ្ញា camelCase វាអាចតម្រូវឱ្យមានការខិតខំបន្ថែមដើម្បីបម្លែងរវាងអនុសញ្ញាដាក់ឈ្មោះ។ ទោះយ៉ាងណា វាមិនមែនជាកង្វល់ធំទេ ព្រោះគម្រោងបានធ្វើស្តង់ដារលើអនុសញ្ញា snake_case។

សរុបមក ការសម្រេចចិត្តប្រើអនុសញ្ញាដាក់ឈ្មោះ snake_case សម្រាប់ endpoint នៃ REST API នាំឱ្យមានវិធីសាស្ត្រស៊ីសង្វាក់ ងាយអាន និងតាមស្តង់ដារឧស្សាហកម្ម ខណៈងាយអនុវត្ត និងថែទាំ។

ឥណទាន៖ ទំព័រនេះត្រូវបានបង្កើតដោយ ChatGPT បន្ទាប់មកកែសម្រួលសម្រាប់ភាពច្បាស់លាស់ និងទម្រង់។