吐槽接口文档(二)——什么是优秀的接口文档
摘要:
昨天说了合格的接口文档,今天继续唠一唠,什么是我觉得优秀的接口文档。 项目部分 首先,优秀的接口文档在合格的接口文档上最显著的一个特征,就是在描述几种项目必须要素基础上,要给出更加详细的说明以及所涉及到的技术细节,甚至要给出关键代码逻辑的demo。例如,除了文字版叙述加密、解密和验证算法以外,要给出 阅读全文
posted @ 2021-09-02 18:26 隔壁王书 阅读(199) 评论(0) 推荐(0) 编辑