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

本文主要是介绍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

这篇关于Web API文档生成工具apidoc 的使用步骤的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---