关闭

Web API文档生成工具apidoc 的使用步骤

1271人阅读 评论(0) 收藏 举报
分类:
1.安装node.js(以window为例)
32 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x86.msi
64 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x64.msi
2.配置nodejs 环境变量
cmd切换到nodejs 安装目录下 输入 path

3.安装配置apidoc

<span style="font-family: Arial, Helvetica, sans-serif;">npm install apidoc -g</span>


设置apidoc.json


运行

apidoc -i myapp/ -o apidoc/ -t mytemplate/

模板的使用 

您可以创建自己的模板,并使用apiDoc生成的文件api_data.js,api_project.js,
查看源代码https://github.com/apidoc/apidoc/tree/master/template

将template内的文件拷贝到apidoc下 然后再执行 

apidoc -i myapp/ -o apidoc/ -t mytemplate/


详细内容参考apidoc文档 

apidocjs.com

0
0

查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
    个人资料
    • 访问:60242次
    • 积分:1220
    • 等级:
    • 排名:千里之外
    • 原创:57篇
    • 转载:45篇
    • 译文:0篇
    • 评论:5条
    文章分类