我想给我的app做一个文档说明,发现已经有轮子了,我之前也造了一个,但是在Laravel上面效果不太好,搜了一下,发现已经有个包了。
https://github.com/mpociot/laravel-apidoc-generator
地址是这个,我的是Laravel 5.5.2版本,其他版本的进去看一下说明即可。
composer require mpociot/laravel-apidoc-generator
然后就直接可以运行自动生成文档了,官方说用下面的命令,结果报错了!
php artisan api:gen --routePrefix="settings/api/*"
错误内容:
[Symfony\Component\Console\Exception\CommandNotFoundException]
There are no commands defined in the "api" namespace.
Did you mean this?
app
解决办法:
找到以下文件:
D:\phpStudy\WWW\douxiaoli\app\Providers\AppServiceProvider.php
在register里面加入这行代码:
public function register() {
$this->app->register(\Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class);
}
再次运行就不报错了。
然后我到生成的文档里面看了一下。路径如下:
D:\phpStudy\WWW\douxiaoli\public\docs
和我想象中有点不一样。