nodejs生成apidoc文档

本地安装node.js

进入对应node.js安装目录

C:\Program Files\nodejs>

在对应目录下安装apidoc

C:\Program Files\nodejs>npm install apidoc -g

• 有可能被墙，注意走代理

进入到对应要生成的apidoc的目录盘

C:\Users\xieziran>d:

执行生成文档命令

D:\git\pc_hi\CloudKvmApi>apidoc -i /git/pc_hi/CloudKvmApi -o /git/pc_hi/CloudKvmApi/apidoc
{"message":"parser plugin 'param' not found in block: 1","level":"warn"}
{"message":"Done.","level":"info"}

代码里添加如下格式，生成出来的文档，就可以通过html查看了

    """
    @api {post} /volume/create_novm 创建无主磁盘
    @apiVersion 1.0.0
    @apiName volume.create_novm
    @apiGroup volume

    @apiParam {string} trace_id 链路追踪id
    @apiParam {string} parent_id 父进程id
    @apiParam {string} module 模块名，disk
    @apiParam {string} action 方法名，create_novm_disk
    @apiParam {string} disk_name 磁盘名称
    @apiParam {string} volume_size 磁盘容量，单位G
    @apiParam {string} storage 存储类型，local:本地存储；ceph:ceph存储
    @apiParam {string} storage_root 存储路径，
        本地存储：磁盘路径，比如/data/instance；
        ceph存储：池名称，比如volumes:6a085c23-2177-242d-7661-c785df7f6230@172.16.1.200:6789,172.16.1.201:6789
    
    @apiSuccessExample {json} 成功
        HTTP/1.1 200 OK
        {
            "code": 0,
            "message": "SUCCESS"
            "data"："volumes/disk_name"
        }
    @apiError ServerInternalError 服务器内部错误
    @apiErrorExample {json} 失败:
        HTTP/1.1 200 OK
        {
            "code": 2,
            "message": "Fails"
        }
    """