johnylemon/explainer-lumen

Lumen 框架的 API 解释器

维护者

详细信息

github.com/johnylemon/explainer-lumen

源代码

问题

安装: 8

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

公开问题: 0

1.0.1 2019-09-04 08:57 UTC

Requires

MIT e8a39878e26558715aa0d8029be01988f47f70a9

  • Piotr Krzempek <johnylemon1989.woop@gmail.com>

restapiswagger

This package is auto-updated.

Last update: 2024-09-04 21:34:03 UTC

README

Laravel 解释器

一个简单的 Laravel API 文档生成器

特性

此工具可以通过使用简单的 explain 方法，通过配置的路线地址下可访问的清晰文档来解释每个应用程序的路由。

安装

  • 将 \Lemon\ExplainerLumen\Providers\ExplainerLumenServiceProvider 添加到您的 app/bootstrap.php 文件中
  • 在提供程序行之后，将 $this->configure('explainer') 添加到您的 app/bootstrap.php 文件中
  • 通过更改以下行将启动应用程序更改为由此包提供：
// $app = new Laravel\Lumen\Application(
//     dirname(__DIR__)
// );

改为以下内容：

$app = new Lemon\ExplainerLumen\Application(
    dirname(__DIR__)
);
  • 将 vendor/johnylemon/explainer/config/explainer.php 文件复制到您的 config 目录

如何使用

只需在您的路由上调用 explain 方法

$router->get('/', 'IndexController@index')->explain(\App\Explains\IndexRouteExplain::class);

示例

解释文件生成

要生成名为 IndexRouteExplain 的路由解释文件，并将其放置在 app/Explains 目录下，请简单输入

php artisan explain:route IndexRouteExplain

解释示例生成

要生成名为 ValidationExample 的路由解释示例文件，并将其放置在 app/Explains/Examples 目录下，请简单输入

php artisan explain:example ValidationExample

生成文档

简单输入

php artisan explain

然后...享受吧！