通过 
搜索
搜索codev / apidocs
Laravel API 文档生成器
2.0.3
2021-05-23 05:25 UTC
Requires
- php: ^7.3
- illuminate/support: ^8.41
Requires (Dev)
- phpunit/phpunit: ~4.0
README
此 Laravel 扩展包提供了一个基于您的路由和控制器方法 DocBlock 注释的 API 文档生成器。Packagist: https://packagist.org.cn/packages/codev/apidocs
安装
Laravel 5.0 -> 8.0
首先通过 Composer 安装此包。编辑您的项目 composer.json 文件以要求 codev-vn/apidocs。
composer require --dev codev/apidocs
然后，从终端更新 Composer
composer update
安装完包后，最后一步是添加服务提供者。打开 config/app.php，并将新项目添加到 providers 数组中。
'Codev\Apidocs\ApidocsServiceProvider',
从终端运行 artisan 命令以查看新的 apidocs 命令。
php artisan apidocs:generate
通过运行此 artisan 命令创建 API Docs 配置的副本
php artisan vendor:publish
备注
路由前缀
为您的路由创建一个带有 API 版本的名称前缀。例如：'api/v1
Route::group(['prefix' => 'api/v1'], function(){
// ...
});
######## Laravel 5.4 默认为 api 前缀 (Route::prefix('api'))。如果您的 routes/api.php 看起来像这样...
Route::group(['prefix' => 'v1'], function(){
// ...
});
... 生成命令的路由将是 api/v1 否则它将是仅 api
DocBlock 示例
下面是一个 docBlock 示例。
/**
* Display the specified resource.
* GET /user/{id}
*
* @param int $id The id of a User
* @return Response
*/
public function show($id)
{
// Display User
}
许可证
我们正在从 https://packagist.org.cn/packages/f2m2/apidocs 开发此包。我们请求 F2M2 的许可，使用源代码进一步开发项目并服务于社区。感谢 F2M2。
Codev Service Co.,Ltd 在 https://codev.vn
查看 LICENSE 文件。