请问大家用什么工具写接口文档?如何保证接口文档更新?

我们是采用postman验证接口成功,复制接口地址、复制参数、复制返回结果添加yapi工具文档。员工觉得写API文档比较麻烦,且接口调整又忘记更新导致文档陈旧。欢迎大家讨论!

讨论数量: 19
翟宇鑫

我感觉 apizza 不错

2年前 评论
huangYX (楼主) 2年前
你看我吊吗啊

www.apifox.cn/#
@api_fox

www.apipost.cn/ @APIPOST

2年前 评论

eolink真心推荐都不用下载安装,直接线上访问

2年前 评论
你看我吊吗啊

@摇曳的猫 但是人员限制5人以内

2年前 评论

apipost apifox之类的,测试完接口整理下字段描述文档就生成好了 :grin:

2年前 评论

postman 本身也不错吧?

2年前 评论
你看我吊吗啊

@839891627 是的

2年前 评论
你看我吊吗啊

@摇曳的猫 我擦 上半年还有呢 。。

2年前 评论

@你看我吊吗啊 不过我们公司都不用,他们用docway,这是我自己用的

2年前 评论

我都用文本编辑器

2年前 评论

apipost 测试完直接填充参数和响应了。 就是文档地址会长一点。

2年前 评论
Junwind

protobuf

2年前 评论

apifox,目前不限人数,也不建议swagger,浪费大把时间写文档,还多。

2年前 评论
zhuzixian520

一般比较常用的是swagger 针对yii2 框架,我写了一个简单的自动生成接口文档的扩展 github.com/zhuzixian520/yii2-api-d... 欢迎指正,谢谢

2年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!