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 生成,之后为了清爽搭格式做过编辑。