apidocjs使用过程记录

apidocjs 设置记录：


路径： /opt/webapps/apidoc/apidoc/ -----存放页面生成的地方：
http://localhost/apidoc/index.html (all，所有api的doc)
http://localhost/apidoc/relation/index.html (relation-rest)
http://localhost/apidoc/app/index.html     (app-rest)


script: 讲工程从git上down下来，然后用apidoc工具讲工程内的相关注释码生成页面存放到webapps/apidoc/内
/opt/script/apidoc/ -----apidoc页面生成脚本
./deployrest-all.sh 将git/下面所有注释码生成在一个页面内
./relation-apidoc.sh 将git/下的relation-rest内的注释码生成单独页面内
./app-apidoc.sh
。。。
app-apidoc.sh
#!/bin/bash
ip=xxx.xxx.xxx.xxx //发布的服务器


echo  "build gongzuoquan-app-rest API DOC ..."
cd /opt/git/gongzuoquan-app-rest
git fetch
git checkout $1
git pull


apidoc -i /opt/git/app-rest/ -o /opt/webapps/apidoc/apidoc/app/ -c /opt/script/apidoc/app/
ssh root@$ip " rm -rf /opt/webapps/apidoc/apidoc/app"
#sh root@$ip " mkdir -p /opt/webapps/apidoc/apidoc/app && cd /opt/webapps/apidoc/apidoc/app && rm -rf * "
scp -r /opt/webapps/apidoc/apidoc/app root@$ip:/opt/webapps/apidoc/apidoc/app
echo "app-rest end"



工具命令： apidoc -i inputPath/ -o outputPath -c configPath
-i 注释代码源
-o 生成输出源
-c 配置文件，即存在apidoc.json文件，里面配置页面版本号，标题，描述等之类，（或者在inputPath/下存在apidoc.json可不用配置-c）
such: apidoc -i /opt/webapps/apidoc/doc/relation/ -o /opt/webapps/apidoc/apidoc/relation/ -c /opt/webapps/apidoc/doc/relation/


左侧导航中文设置（默认会把特殊字符转换成 ____ ）：
..\apidoc-core\lib\workers\api_group.json
注释掉83行的：group = group.replace(/[^\w]/g, '_');

注释格式：
such
/**
* @api {get} /relation/rest/appState appState                  //方法名，appState 对应页面左侧导航索引名
* @apiGroup RestTeamMember //类名，主导航
* @apiName appState //与apiGroup使用，决定一个版本,apiName不同，则不能版本间比较
* @apiDescription 服务器状态监控 //方法作业描述
* @apiVersion 0.0.0 //版本号，用于版本间的比较
* @apiParam {HttpServletRequest} req   is servlet request test //参数信息即描述
*/

更多注释详情请看：http://apidocjs.com/