## 使用apiDoc生成接口数据 查看apiDoc官方文档 - 全局安装apiDoc，必须安装0.29.0或以下版本；新版本不再支持生成api_data.json等数据文件，导致无法导入Apifox

## 使用apiDoc生成接口数据 查看apiDoc官方文档 - 全局安装apiDoc，必须安装0.29.0或以下版本；新版本不再支持生成api_data.json等数据文件，导致无法导入Apifox

本文介绍了如何使用apiDoc生成接口文档。首先需全局安装0.29.0或以下版本的apiDoc，并创建配置文件。然后通过命令生成文档，并使用nodemon监听文件变动以自动更新文档。此外，介绍了如何在Apifox中自动导入apiDoc数据，设置项目后可通过指定URL导入数据并开启自动同步。

apiDoc 可以通过文本生成体验良好的 API 文档页面，这些文本可以以注释的形式放在代码里，apiDoc 读取源码注释，就可以生成页面了，当然也可以与代码分开，写一些全是注释的文档，作为 apiDoc 生成文档页面的「源文件」。

在前后端分离框架中，API 文档频繁交接。如果涉及到第三方接口调用，多方合作场景下，API 和文档变更可能会更快。为了方便维护 API 和交接文档，这里给大家推荐一款文档生成工具 - apidoc 1.apidoc 简介 apidoc 是一个基于 nodejs 的 API 文档生成工具，从代码注释中提取特定格式的内容，

随着移动客户端的流行，后端系统需开放越来越多的API来供客户端使用。API文档的编写和管理是一个挑战，随着API不断变化，文档必须及时更新，但编写文档也是个不小的负担。一个比较好的做法(Best Practice)，就是将文档放在代码里，开发人员编写代码时同