apidoc

 

 apidoc.js 是web api 文档生成器，官网：http://apidocjs.com/

安装和使用：

1、安装：

官方文档上只有一个命令：npm install apidoc -g ，当然，这个是没法直接执行的。

首选理解 npm 是什么？

npm是一个node包管理和分发工具，已经成为了非官方的发布node模块（包）的标准。有了npm，可以很快的找到特定服务要使用的包，进行下载、安装以及管理已经安装的包。

所以：

首先安装node.js，具体安装步骤参照：http://www.cnblogs.com/linjiqin/p/3765390.html

新版nodejs已经集成了npm，所以之前npm也一并安装好

其次：安装apidoc，这是再执行npm install apidoc -g 就可以

安装过程中如果出现error：npm err registry error parsing json

解决办法：

镜像使用方法（三种办法任意一种都能解决问题，建议使用第三种，将配置写死，下次用的时候配置还在）:

• 1.通过config命令

npm config set registry https://registry.npm.taobao.org 
npm info underscore （如果上面配置正确这个命令会有字符串response）

• 2.命令行指定

npm --registry https://registry.npm.taobao.org info underscore 

• 3.编辑 ~/.npmrc 加入下面内容

registry = https://registry.npm.taobao.org

搜索镜像: https://npm.taobao.org

 

建立或使用镜像,参考: https://github.com/cnpm/cnpmjs.org

 

安装成功，使用命令 apidoc -v 可检查当前安装是否成功及对应版本号

 2、apidoc的使用

1）cmd，然后转到D盘，D:

2）转到代码目录

cd D:\workspace\test\src\main\java\com\test

3）执行脚本

   apidoc -i web/ -o web/api/