为什么开发人员都不愿意写接口文档？

[jessezhang1986]

[dfkjgklfdjg]

写代码的同时搭配注解就可以完成一些额外工作，不想写的其实都是懒得写，而且麻烦，用注释可以完成不就好了，
我自己也尝试过，用 JS 实现了一部分的自动生成文档，后来后端用了 Swagger 我这边就不需要做文档了。

Swagger 通过注解的方式来生成对应的 API，包括自动文档，代码生成和测试用例生成。

[romisanic]

一方面是懒吧，就是不想多花力气
另一方面是对于一些人而言，深入思考规划的能力比较欠缺，导致不用等到新的需求，本次需求实现过程中就要多次修改接口方案，原本只需要改一下代码，现在还需要同步设计文档，会觉得麻烦很多
还有一个常见的情况是任务没有给写文档的时间

[lazy21]

apifox +1

[xcstream]

看情况 慢工细活 弄弄文档很合理。
追求速度，能用就行。

[qdzzyb]

不给时间 写什么文档

[wanguorui123]

不都是自动生成的吗？

[jessezhang1986]

@apifox 牛逼，这个 Apifox （ apifox.cn ） 确实可以解决这个问题

[LemonK]

捏着鼻子逼自己仔仔细细写好文档，然而前端根本不看，还是动不动来问。
没文档，问了你直接回答就行。有文档，你为了证明有文档，还得打开 VPN，打开文档页，找到对应接口，截图那一两行给他。
这种情况发生个一二十次，成功培养了我不写文档的好习惯。

[charlie21]

有专人负责写文档

[AlanDSF]

@AoEiuV020 逻辑毫无毛病，同感

[luvroot]

对自己意义不大

[DoctorCat]

如果是用 Python 技术栈，安利一下：FastAPI，自动生成文档，不再是问题。

[gy0624ww]

都是国内 IT 畸形发展的结果
包括单元测试

[old9]

这一唱一和广告打的

[gucheen]

这么多人还没看出来这就是个推广贴

[falcon05]

@gucheen
@old9

真相了，看了下这楼主的历史回复，这…

[juwins1993]

我们这边用 yapi 管理接口，然后用 idea 插件生成文档并推送，不需要专门写

[normanzhxu]

@juwins1993 我这里也有 yapi 。同时在代码框架上也支持检测接口 并获取接口信息的

[codepark]

虽然是广告 我就不妨试试 apifox 哈哈

[chenshun00]

其实还是一个投入产出比的问题，写文档对当时的人来说投入过多了，但是又没有什么收益。毕竟接口开发完了(kpi?) ， 能用就行了.

为了降低投入，搞了一个 IDEA 插件，一键手机，投入从 1 降低到 0.05 。