Laravel5中生成指定文件的说明文档

首先安装apidoc：npm install apidoc -g

用法：
1、

apidoc -i app/Http/Controllers/Api -o ./doc

表示将app/Http/Controllers/Api目录下的所有文件生成文档，并保存到当前位置的doc文件夹下面。

2、

apidoc -i ./app/Http/Controllers/Api/ -o ./public/doc

这行命令的意思是将./app/Http/Controllers/Api/下的文件生成说明文档到./public/doc/下面。其中，-i:input，
-o:output

在我们的项目中app/console/apidoc.php定义为了命令： ./artisan doc:make

apidoc.php内容如下：

<?php namespace App\Console\Commands;

use Illuminate\Console\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;

class apidoc extends Command {

/**
 * The console command name.
 *
 * @var string
 */
protected $name = 'doc:make';

/**
 * The console command description.
 *
 * @var string
 */
protected $description = '生成接口文档.';

/**
 * Create a new command instance.
 *
 * @return void
 */
    public function __construct()
    {
        parent::__construct();
    }

/**
 * Execute the console command.
 *
 * @return mixed
 */
    public function fire()
    {
        $command = system("apidoc -i ./app/Http/Controllers/Api/ -o ./public/doc");
        $this->info($command);
    }


}

apiDoc的官方地址：http://apidocjs.com/
apiDoc用法（语法）文档地址：http://apidocjs.com/#param-api

Author:leedaning
本文地址：http://blog.csdn.net/leedaning/article/details/47004983