johnylemon/explainer-laravel

laravel框架的API解释器

维护者

详细信息

github.com/johnylemon/explainer-laravel

源代码

问题

安装: 8

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

公开问题: 0

v1.0.1 2019-05-17 23:52 UTC

Requires

MIT e8a9031718b3679ea6abb873c2babcb1b38aa547

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

restapiswagger

This package is auto-updated.

Last update: 2024-09-18 11:20:34 UTC

README

laravel解释器

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

核心包：https://github.com/johnylemon/explainer

功能

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

如何使用

简单地在路由上调用explain方法

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

示例

解释文件生成

要在app/Explains目录中生成名为IndexRouteExplain的路由解释文件，只需输入

php artisan explain:route IndexRouteExplain

解释示例生成

要在app/Explains/Examples目录中生成名为ValidationExample的路由解释示例文件，只需输入

php artisan explain:example ValidationExample

生成文档

只需输入

php artisan explain

然后...享受吧！