自动生成一个高大上的api文档

ApiDoc官方文档隆重登场 登登登登！

ApiDoc是根据添加注释的方法来生成相应的文档，操作相当简单实用。http://apidocjs.com/

1. 粘贴注释之前需要先安装一下：

npm install apidoc -g

2. 一起进入官网粘注释去：
   
3. 粘贴到接口上方：
   
4. 创建一个文件，命名为apidoc.json，并粘贴下图代码（参见官网）
   
   可根据需要进行修改：

{
    "name": "一个高大上的api文档",
    "version": "0.1.0",//版本号
    "description": "这里是描述",
    "title": "这里是api标题",
    "url" : "http://localhost:3000" //域名
  }

5. 在相应的目录下新建文件夹src，并把你要生成文档的接口文件放进去，修改相应的引入路径。
6. 输入指令

apidoc -i ./src -o ./apidoc 
//将src文件夹下的注释编译成一个api文档，并放入apidoc文件夹下。

7. 然后就看到生成了一个apidoc文件夹
   
8. 打开html文件，神奇的事发生啦！！！