APIDOC使用教程

安装

nodeJs Install

• [nodeJs] - https://nodejs.org/en/download/!
• [NPM] - Installing Node.js via package manager

APIDOC Install

$ npm install -g apidoc  

Install check

使用win+R快捷键打开运行窗口，在文本框中输入cmd并回车打开Windows Shell。

$ node -v  
$ npm -v  
$ apidoc -v  

使用

Run command

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

参数	描述
-i	源代码所在的位置
-o	生成的目标文件所在的位置
-t	为生成文件选择模板，可以创建和使用自定义的模板
-h	打印出帮助文档
-f	选择要解析的文件，支持正则表达式。-f参数可以使用多次，多个表达式可以对应不同的-f。如：apidoc -f “.*.js$$\begin{gathered} "-f".\ast \\ .ts \end{gathered}$$”

apidoc.json

{
  "name": "tspdre",
  "version": "1.0.0",
  "description": "接口文档",
  "title": "平台对接",
  "url": "http://api.tt.cn",
  "sampleUrl": "http://api.tt.cn/test"
}