知识卡片

文档贴近源码

专业/工作 · 401

内容

API 文档若能从源码注解或注释自动生成,就能减少手写文档与真实接口不一致的问题。发散:接口文档应进入构建流水线,和测试、打包、部署一样成为交付产物,而不是上线前临时补写的说明书。

参考来源

《架构探险:轻量级微服务架构(下册)》第6章《微服务测试》