rorntuck7的专栏

php java android

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

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

阅读更多
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/rorntuck7/article/details/52355118
个人分类: 前端
上一篇Laravel 整合 JWT 的方法
下一篇mysql查询今天,昨天,近7天,近30天,本月,上一月数据方法
想对作者说点什么? 我来说一句

js中文帮助文档

2017年03月31日 603KB 下载

没有更多推荐了,返回首页

关闭
关闭