README

用于管理API文档的包。该包处于开发中，但目前已经可以用来管理您的API文档。

更多详细信息，请查看完整文档 (仍在建设中)

安装

通过composer安装

javascript composer require firmino/apidoc

手动安装，请在您的 composer.json 文件中添加以下行

javascript "firmino/apidoc": "dev-master"

在 config/app.php 文件中注册 ServiceProvider

'providers' => [
      Package\Firmino\Apidoc\Providers\ApiDocServiceProvider::class,
]

同样在该文件中注册 Facade

'aliases' => [
      'Doc' => Package\Firmino\Apidoc\Facades\Apidoc::class,
]

执行以下命令以发布配置面板所需的文件

php php artisan vendor:publish --provider="Package\Firmino\Apidoc\Providers\ApiDocServiceProvider"

运行迁移

php php artisan migrate

访问默认路由 /apidoc 来查看面板。这些信息可以在配置文件中修改。

当前可用的Facade具有以下两个方法

返回所有已注册的Api

返回所有注册的参数