Laravel 文档自动生成器
mpociot/laravel-apidoc-generator
简介&安装
Laravel API 文档生成器扩展包可以基于 Laravel 应用路由自动生成项目 API 文档。
我们使用Composer安装这个扩展包
composer require mpociot/laravel-apidoc-generator
安装完成后需要到`config/app.php`中注册服务提供者：
Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class,
基本使用
基础示例
下面我们来演示如何使用这个扩展包自动为项目生成API文档，其原理是通过扫描api.php为指定路由生成相应API文档，比如我们的路由文件定义了一个路由如下：
Route::get('/category/test','CategoryController@category_test');
控制器的方法如下：
/**
* API首页
*
* 欢迎来到Laravel学院，Laravel学院致力于提供优质Laravel中文学习资源
*
*/
public function category_test(TestRequest $request){
$taxonomy = CategoryTaxonomy::where('term_taxonomy_id',24)->first()->terms->first();
return $taxonomy;
}
然后执行：
php artisan api:generate --routePrefix="api/category/test"`
前台打开 http://your_web_site/docs/,查看为如下结果
带参数的请求api示例
我们还是已上面的路由为例，首先创建一个请求
php artisan make:request TestRequest
然后在请求的中写参数：
public function rules()
{
return [
'title' => 'red|max:255',
'body' => '',
'type' => 'in:foo,bar',
'thumbnail' => 'required_if:type,foo|image',
];
}
控制器代码如下：
/**
* API请求参数
*
* @param App\Http\Requests\TestRequest $request
*
*
*/
public function category_test(TestRequest $request){
$taxonomy = CategoryTaxonomy::where('term_taxonomy_id',24)->first()->terms->first();
return $taxonomy;
}
前台打开 http://your_web_site/docs/, 查看为如下结果
以上就是基本的laravel 文档生成工具的基本使用，欢迎关注我的博客，不定期分享技术文档。
附上地址laravel-apidoc-generator
Social Menu