README

Laravel API 文档生成器

此 Laravel 包提供基于您的路由和控制器方法 DocBlock 注释的 API 文档生成器。

安装

Laravel 5.0

首先通过 Composer 安装此包。编辑您的项目 composer.json 文件，以添加对 f2m2/apidocs 的依赖。

"require-dev": {
    "tao2581/apidocs": "dev-master"
}

接下来，通过终端更新 Composer

composer update

一旦安装了包，下一步是添加服务提供者。打开 config/app.php，并在 providers 数组中添加一个新条目。

'F2m2\Apidocs\ApidocsServiceProvider',

从终端运行 artisan 命令以查看新的 apidocs 命令。

php artisan apidocs:generate

运行此 artisan 命令以创建 API Docs 配置的副本

php artisan vendor:publish

Laravel 4.2

查看安装：[https://github.com/f2m2/apidocs/tree/1.0.0](https://github.com/f2m2/apidocs/tree/1.0.0)

注意

路由前缀

为您的路由创建一个带有 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
}

许可证

查看 LICENSE 文件。

tao2581 / apidocs

维护者

详情