下面我们来演示如何使用这个扩展包自动为项目生成API文档,其原理是通过扫描routes.php为指定路由生成相应API文档,比如我们的路由文件定义了一个路由如下:
Route::get('api/v1/index', 'ApiController@index');
这个路由对应的控制器方法定义如下:
/**
* API首页
*
* 欢迎来到Laravel学院,Laravel学院致力于提供优质Laravel中文学习资源
*
*/
public function index()
{
}
需要指出的是,Laravel API 生成器通过action方法上的注释生成 API 相应的描述信息。我们使用扩展包提供的api:generate命令来实现 API 文档生成:
php artisan api:generate --routePrefix=api/v1/*
该命令的意思是扫描路由中匹配api/v1/*的规则并为相应控制器方法生成API文档,