最近要整理公司的接口
有没有好的工具能够去编写这个文档
取决于你们公司使用的开发语言吧。
比如用的是Java，就用Javadoc；
用的是Javascript，就用jsdoc；
用的是Ruby，就用RDoc；
用的是Obj-c，就用appledoc；
等等。
当然最关键是，原来的接口相关的注释是否有恰当地编写
新手上路，请多包涵
swagger是我用过最好用的，只是编写相关的json比较麻烦，又不想集成在代码中。不过可以在网站(www.sosoapi.com)上在线表单方式编写swagger-ui对应的json哈，编辑简单而且可以在线预览和导入导出，挺方便的
推荐问题
接口测试成功，但实际使用时返回为空值？
我在测试一个php文档时，遇到了接口测试成功，但实际使用时返回为空值的问题。场景如下，这个php文件使用get方式接受前端的数据： {代码...} 装成数组以后： {代码...} 返回给前端 {代码...} 但在测试之中出现了问题，我尝试了几种改动：1.使用apifox测试，有正常返回： {代码...} 2.使用在线接口测试，返回空值： {代码...2 回答1.2k 阅读✓ 已解决
python使用StreamingResponse进行流式传输，一直出现socket.send() raised exception，该怎么解决？
在python环境下使用fastAPI编写了一个流式响应的接口，在多次调接口的时候后台会不断报错socket.send() raised exception,一直循环报错，导致接口无法使用。1 回答317 阅读
宣传栏
可以了解一下Doxygen，它基于代码中特定格式的注释，可自动生成HTML(还有其它可选格式)的API文档。
工具主页如下：
http://www.doxygen.nl/
具体内容自行参考官方说明。