使用apidoc生成restful-api文档:安装nodejs+npm+apidoc_api-docs;加.js

前言：

swagger可以实时生成api文档，但是侵入性比较强，所以这里尝试了一下apidoc，当然都是自己瞎折腾，各位同学有啥推荐的可以评论哦。

开发环境：

windows

资源链接：

Node.js安装包下载
apidoc源码

安装步骤：

Step1:下载
下载node.js安装包：打开上面的下载连接选择一个版本，然后选择x64的msi版本(这里是windows环境)，下载完成点击安装选择，安装路径，一直下一步就行了，不用特别配置。
Step2:cmd命令行安装
打开cmd，依次输入以下命令：

npm -v
1

显示版本号则安装成功
（前面路径不要管，这是我自己切进去弄其他东西的，直接输入上面的命令就行了）

npm install apidoc -g
1

好，到这里安装工作就完了。
Step3:生成doc
1）新建doc目录

cd *项目目录*
mkdir doc
1
2

命令行cd到项目文件夹上级补录，新建文件夹doc

2）生成api文档

apidoc -i springboot-mybatis/ -o doc/
1

3）查看生成的api文档

补充：注释格式

偷懒偷懒，apidoc的github项目里就有example，地址在文头已给出链接。