您的位置:首页 > 其它

ApiDoc 自动生成API文档

2017-12-15 13:56 225 查看
1、确认已经安装node.js

可以使用npm命令

否则要先安装node

2、安装apidoc

命令行运行

npminstall
apidoc -g

3、在项目的当前目录下编写一个脚本genAPIdoc.bat

内容为

apidoc -o ../doc/apiDoc/

Pause

(将生成的API文档 -o 输出output到上层文件夹的doc/apiDoc下)

4、配置(apidoc.json)

{

  "name": "js_iot_emergency_command",

  "title":"emergencyCommandAPI",

  "description":"emergencyCommandAPI接口文档",

  "url" : "http://api.demo.com",

  "version": "0.1.0"

}

5、配置完成之后,在命令行下进入项目目录,运行脚本文件genAPIdoc.bat

即可在doc/apiDoc下自动生成API文档

打开index.html
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: