安装配置apidoc文档生成工具

1:首先需要安装node.js

网址: https://nodejs.org/en/#download

2:输入命令进行安装

npm install apidoc -g

3:生成doc目录

例子:apidoc -i ~/Tools/apidoc-master/ -o doc/
格式: apidoc -i myapp/ -o apidoc/ -t mytemplate/
-o --output :输出的文件夹路径
-i --input:输入的文件夹路径
-t --template :使用模板输出文件。您可以创建和使用自己的模版

4:配置apidoc.json文件

{
"name": "example",
"version": "0.1.0",
"description": "apiDoc basic example",
"title": "Custom apiDoc browser title",
"url" : "https://api.github.com/v1"
}

你可能感兴趣的:(安装配置apidoc文档生成工具)