apidocs的使用

 

安装node.js

https://nodejs.org/en/download/

查看node版本：node -v

查看npm版本：npm -v

默认安装路径：C:\Users\Administrator\AppData\Roaming\npm

安装apidoc

npm install apidoc -g

创建要生成文档的文件：

apidoc.java

/**
 * @apiDefine group1 我的建议
 */
/**
 * @apiDefine group2 详情
 */
/**
 * @apiDefine group3 流程记录
 */


/**
 * @api {get} /public/app/mySuggestListForApp.action
 * @apiName 我的建议
 * @apiGroup group1 
 *
 * @apiParam {String} useruuid 用户uuid
 *
 * @apiSuccess {String} fileTitle 案由
 * @apiSuccess {String} fileStatus 状态
 * @apiSuccess {String} fileName 领衔代表
 * @apiSuccess {String} fileuuid fileuuid
 */

/**
 * @api {get} /public/app/getBillInfoforJson.action
 * @apiName 建议详情
 * @apiGroup group2 
 *
 * @apiParam {String} useruuid 用户uuid
 * @apiParam {String} fileuuid 主表uuid
 *
 * @apiSuccess {String} fileTitle 案由
 * @apiSuccess {String} fileName 届次
 * @apiSuccess {String} fileHeadername 领衔人
 * @apiSuccess {String} fileSuggestcategory 建议分类
 * @apiSuccess {String} filerecordnum 立案编号
 * @apiSuccess {String} fileMobile 领衔人电话
 * @apiSuccess {String} fileSuggesttime 时间
 * @apiSuccess {String} fileHeaderaddress 领衔人地址
 * @apiSuccess {String} fileHostsname 主办单位
 * @apiSuccess {String} fileAssistsname 会办单位
 * @apiSuccess {String} fileJoins 联名代表
 * @apiSuccess {String} fileContent 建议内容
 */


/**
 * @api {get} /public/app/getProcessrecord.action
 * @apiName 流程记录
 * @apiGroup group3 
 *
 * @apiParam {String} useruuid 用户uuid
 * @apiParam {String} fileuuid 主表uuid
 *
 * @apiSuccess {String} wfhistoryCdate 处理时间
 * @apiSuccess {String} wfhistoryResult 处理动作
 * @apiSuccess {String} wfhistoryOpinion 处理意见
 */

 

 apidoc.json

{
    "name": "XXXXXXXX系统",
    "version": "1.0.0",
    "description": "app接口",
    "title": "demo",
    "url": "http://127.0.0.1:8088",
    "sampleUrl": "http://127.0.0.1:8088",
    "header": {
        "title": "首页",
        "filename": "header.md"
    },
    "footer": {
        "title": "版权信息",
        "filename": "footer.md"
    },
    "order": [
        "Error",
        "Define",
        "PostTitleAndError",
        "PostError"
    ]
}

footer.md和header.md随便从模板例子拷贝一个就可以

执行生成命令：apidoc -i D:\myeclipse2013\workplace\apidoc  -o c:/222

D:\myeclipse2013\workplace\apidoc是我要生成的文件路径，c:/222这个文件是我用来存放生成的文件路径

另外有更加详细案例介绍：https://www.cnblogs.com/minsons/articles/7154090.html