apidoc文档使用方法

0、本项目以laravel框架为例；

1、安装： https://apidocjs.com （安装完成后所有位置都能执行相关衡陵命令）；

2、项目根目录创建apidoc.json文件；

3、控制器中编写对应的文档信息；

4、根目录执行命令生成文档；

1、安装根据官网教程即可；

2、项目根目录创建对应的json文件；内容如下

3、控制器中编写对应的文档信息；(注闹册释部“/**/”分为文档生成的内容)

4、根目录执行命令生成文档；

app/Http/Controllers/Admin ---需要生成文档的控制器咐弯戚地址

public/apidoc/admin ---生成的文档保存位置

1) 编写不方便。每次新增借口的时候都要复制上一个接口，然后再进行修改，一些相同的部分无法复清乎用，接口多了文档会变的很长，还经常需要调整格式。2) 发布不方便。文档更新时，需要发给需要的小伙伴。即使用Git来进行管理，虽然拉取比较方便，但由于文件格式的问题，也不方便比较两次提交的差异。

由于有这些问题，决定寻找一种更优雅有效的方式来编写文档。经过比较，发现了apidoc,可以比较好的解决上面提到的问题。apidoc采用了一种类似写代码注释的方式来写文档，支持编写多种语言的文档。最后生成的文档以网页的形式发布，方便快捷答悔悉，便于阅读。下面就来简单介绍一下怎么使用apidoc来写文档。

1.安装node

由于apidoc依赖Node.js的包管理工具npm进行安装，所以安装apidoc之前要先安装node.js（npm会在安装node时顺带进行安装）。具体的安装教程可以前源参考这里。

2.安装apidoc

安装完了npm之后，就可以安装apidoc了。在命令行输入

---