知识卡片
接口描述可生成多端表示
调用端和提供端都需要知道同一接口的参数、结构及错误含义,人工各写一份容易分叉。用中立描述作为共同来源,再生成文档、测试或不同语言的客户端,可以减少同步维护。生成不能消除接口版本和业务语义责任,外部API若没有现成规范,仍要明确谁维护本地描述及如何跟踪变更。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 9 DRY——邪恶的重复 · 查看原书依据
用来将API描述成一种中立的格式。这些工具通常能生成文档、模拟API、功能测试。之后还可以生成不同语言的API客户端。理想情况下,这个工具会把API保存在一个中心仓库中,以便不同的团队共享。 外部 API 间的重复 你会
参考来源
- 位置:《程序员修炼之道:通向务实的最高境界(第2版)》,`extracted/程序员修炼之道:通向务实的最高境界(第2版)/_epub-src/text/part0011_split_002.html`。
- 结论依据:本处实际展开的论点与例证;正文中的读者边界分析不冒充原书已提供的实现。
- 原始内容:用来将API描述成一种中立的格式。这些工具通常能生成文档、模拟API、功能测试。之后还可以生成不同语言的API客户端。理想情况下,这个工具会把API保存在一个中心仓库中,以便不同的团队共享。 外部 API 间的重复 你会