22 年 3 月 25 日 星期五

(已编辑)

224 字

2 分钟

使用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
  • 保存，立即导入
  • 按需开启自动导入

欢迎关注我的其它发布渠道

公众号小程序

文章标题：apifox自动导入apidoc接口数据

文章作者：bmqy

文章链接：https://bmqy.net/2645.html[复制]

最后修改时间：

商业转载请联系站长获得授权，非商业转载请注明本文出处及文章链接，您可以自由地在任何媒体以任何形式复制和分发作品，也可以修改和创作，但是分发衍生作品时必须采用相同的许可协议。
本文采用CC BY-NC-SA 4.0进行许可。