使用apiDoc
生成接口数据
查看apiDoc
官方文档
- 全局安装
apiDoc
,必须安装0.29.0
或以下版本;新版本不再支持生成api_data.json
等数据文件,导致无法导入Apifox
text
npm install apidoc@0.29.0 -g
- 创建配置文件
apidoc.json
json
{ "name": "example", "version": "1.0.0", "description": "apiDoc basic example", "title": "Custom apiDoc browser title", "url" : "https://api.github.com/v1"}
- 生产文档命令
text
apidoc -i src -o apidoc/ -f .jsp
- 监听文件变动,执行生产文档命令
text
# 全局安装 nodemon
npm install -g nodemon
# nodemon监听指定目录文件变动,并执行指令
nodemon -w input/ -e js -x "apidoc -i input/ -f .js -o apidoc/"
# or
nodemon --watch input/ --ext js -exec "apidoc --input input/ --file-filters .js --output apidoc/"
使用Apifox
自动导入apiDoc
数据
- 创建好项目
- 依次打开
项目设置
、数据管理
、导入数据(自动同步)
数据源格式
选择apiDoc
,数据源url
填入http://xxx.xxx/api_data.json
保存
,立即导入
- 按需开启
自动导入