README

Laravel应用的自动API文档生成器。

快速开始

安装

通过Composer安装

您可以直接通过执行以下命令添加此包

$ composer require rabblerouser/api-autodoc:*

-- 或者 --

手动在composer.json文件的require键中添加

"rabblerouser/api-autodoc": "*"

并运行Composer更新命令

$ composer update

添加服务提供者（Lumen）

将以下服务提供者添加到您的bootstrap/app.php文件中。

$app->register(RabbleRouser\ApiAutoDoc\Providers\DocumentationServiceProvider::class);
$app->register('Irazasyed\Larasupport\Providers\ArtisanServiceProvider');

添加服务提供者（Laravel）

将以下服务提供者添加到您的config/app.php文件中。

'providers' => [
    // Other Service Providers
        RabbleRouser\ApiAutoDoc\Providers\DocumentationServiceProvider::class,
        'Irazasyed\Larasupport\Providers\ArtisanServiceProvider'
],

覆盖文档视图模板

如果您想覆盖默认视图模板，请运行Artisan的publish命令。

$ php artisan vendor:publish

这将创建一个位于Lumen/Laravel安装resources目录中的vendor/api-autodoc/views/目录。Api AutoDoc将加载这些模板而不是默认模板。

使用方法

在您的应用程序的routes.php文件中，将一个docCategory参数添加到路由数组中。

示例

    $app->get('some_resource', [
        'uses' => 'App\Http\Controllers\SomeResourceController@index',
        'docCategory' => 'Some Resource'
    ]);

您可以通过访问您网站上的/docs页面来查看自动生成的API文档。

示例

    http://api.mywebservice.com/docs

rabblerouser/api-autodoc

维护者

详细信息