知识卡片
API三标准
内容
好的 API 至少满足可理解性、封装性和可扩展性。名字让调用者猜得准,参数隐藏内部细节,扩展点预留未来变化;三者缺一,接口都会在使用中变成隐性成本。
参考来源
- 位置:《程序员的底层思维》第11章《契约思维》11.2节「软件设计中的标准」(源文件:Cheng Xu Yuan De Di Ceng Si Wei_split_016.html)
- 结论依据:原文明确列出良好API设计要遵循可理解性、封装性、可扩展性三个标准,并说明扩展性设计要在Map式和字段式两个极端间折中,直接支持卡片论点。
- 原始内容:"良好的API设计要至少遵循3个标准,分别是可理解性、封装性和可扩展性。……对于API可扩展性的选择,我提倡一种折中的方案,用显性化的字段表达核心模型的核心属性,同时预留扩展属性,以应对未来可能发生的变化。"