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 ແລ້ວແກ້ໄຂເພື່ອຄວາມຊັດເຈນ ແລະ ຮູບແບບ.