laravel apidoc工具使用

apidoc是一种风格优雅的API文档生成工具。

第一步：安装nodejs

curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -  
sudo apt-get install -y nodejs

注意：此处需要下载一个依赖工具：
sudo apt-get install -y build-essential

查看是否安装成功
nodejs -v
npm -v 

第二步：安装apidoc

npm install apidoc -g
apidoc -v

查看命令路径
whereis apidoc

第三步：将apidoc加入全局变量

修改/etc/profile文件，在最后加上下面代码即可
export PATH="$PATH:/usr/local/bin/apidoc"
保存，并执行
source /etc/profile

第四步：代码注释格式说明

官方文档

第五步：配置apidoc.json文件

{ 
  "name": "laravel5 API文档", 
  "version": "0.1.0", 
  "description": "apiDoc basic example",
  "title": "Custom apiDoc browser title", 
  "url" : "localhost:10199/doc"
  //此处文档的生成是在public/doc下，所以url配置是这样，其他就自行修改
}

第六步：生成文档

#将laravel目录下的控制器生成api文档，命令如下：
apidoc -i app/Http/Controllers -o public/doc

可能遇到的问题：
1.json文件配置url不对，导致一直加载中
2.注释格式不正确，导致无法生成文档

http://apidocjs.com/#getting-started（官方文档）
http://www.jianshu.com/p/a799c23234b8