知识卡片

普通读书笔记卡 · 1901.b.1

API命名对齐资源与操作语义

理解等级:中级

同类操作用一致动词,例如create、add、delete、update、get、list、page、count,能减少接口学习成本;每个词的实际范围仍须在团队约定。面向资源的HTTP接口通常把资源名放进URI,操作由方法等协议语义表达。不要把某份团队命名表当成所有API风格的唯一标准,也不沿用书中Google百分比作当前统计。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • · 查看原书依据

      对资源的增删改查(CRUD)。对于这些API的命名,我们可以做如表11-2所示的约定。 表11-2 API命名约定 Google将这些方法称为标准方法,在其官方文档(见链接11-3)中写着:“标准方法可降低复杂性并提高一致性。Google API代码库中超过70%的AP

    参考来源

    - 位置:《程序员的底层思维》第11章《契约思维》(来源项目book-sources,`extracted/程序员的底层思维/_epub-src/Cheng Xu Yuan De Di Ceng Si Wei_split_016.html`)。 - 结论依据:原文从“对资源的增删改查(CRUD)。对于这些API的命名,我们可以做如”展开,与本卡的“同类操作用一致动词,例如create、add、delete、update、get、list、page、count,能减少接口学习成本;每个词的实际范围仍须在团队约定”对应;正文额外解释的限制、反例或外部校正均不冒充原书保证。 - 原始内容:对资源的增删改查(CRUD)。对于这些API的命名,我们可以做如表11-2所示的约定。 表11-2 API命名约定 Google将这些方法称为标准方法,在其官方文档(见链接11-3)中写着:“标准方法可降低复杂性并提高一致性。Google API代码库中超过70%的AP