Go问答 http接口调试

dncmn · 2018年11月27日 · 最后由 tsingson 回复于 2019年08月19日 · 577 次阅读

你们公司前后端接口调试的时候,会写接口文档吗? 如果有的同事不习惯写文档,你们还会怎么处理

更多原创文章干货分享,请关注公众号
  • 加微信实战群请加微信(注明:实战群):gocnio

可以用 swagger 自动生成接口文档

用 WORD 不行吗?:-)

个人偏向用 word 和 wiki,毕竟 swagger 多少会有代码侵入性

md 也挺好. swagger 个人不推荐。

wiki 可以的

yapi(http://yapi.demo.qunar.com/),这个感觉挺好的,网上找到的,可以尝试下,能当文档看,也能测试接口,可惜我的公司没有用起来

Thank you for your post information. I see the novelty in your text, I will share it for everyone to read. I look forward to reading many articles from you. vex 3

md 文档为主, 同时提供 cli 进行接口测试.

  1. HTTP 与 非 HTTP 都尽量提供 cli ( 带与后台对应匹配的版本号)
  2. Markdown 文档能把接口协议/参数与业务说清楚
  3. cli 可执行文件一是对照了接口文件 ( 会打印输入/输出所有业务字段, 以及 HTTP 其他字段, 包括 http header ) , 二是 cli 有时也供给运维查问题 ( 测试业务数据, 测试帐号, 以及对应服务端各日志的 transactionID .......... )
  4. 有时, cli 也会扩展成为一些半自动化测试工具或一些辅助工作, 比如批量开户, 哈哈

不用 swagger , 避免不必要暴露业务相关的接口描述 不用 word, 这个比较难做版本管理, 当然, md 转成 word 或 pdf 很容易......... 不用 wiki , 和 swagger 一样, 有些业务接口, 只限某些人员知道, 二是, wiki 的版本管理与权限管理, 对小团队来说, 麻烦. 但版本管理工具不一样, 权限, 加密都是一个方案, 简单一些

就这样, 祝愉快.

.

需要 登录 后方可回复, 如果你还没有账号请点击这里 注册