README

为Laravel提供无烦恼的自动API文档生成。
Swagger的替代品。

快速:在任何Laravel项目中安装

无烦恼:自动生成请求规则和参数的API文档

分析:内置SQL查询时间分析器、响应时间和头部输出。

功能

自动从Laravel路由中获取路由
自动从注入的请求中获取规则
支持授权头部
支持Laravel中的SQL查询、响应时间和请求的内存消耗
使用faker.js智能自动请求构建器
使用Markdown显示额外文档

在Medium上阅读

无需编写注释即可自动为Laravel生成API文档。

要求

安装

您可以通过Composer安装此包

composer require rakutentech/laravel-request-docs --dev

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag=request-docs-config

用法

在浏览器中查看 /request-docs/

或生成静态HTML

php artisan lrd:generate

生成的文档HTML位于 docs/ 目录中。

设计模式

为了让此插件工作，您需要在控制器内部注入请求类，并遵循设计模式。对于额外的文档，您也可以在控制器方法中使用Markdown。

截图

生成的API文档

尝试API

SQL查询配置文件

响应配置文件

自定义头部

额外

您可以在Markdown中编写额外的文档，它将在仪表板上作为HTML渲染。例如，在控制器中使用它

    /**
     * @lrd:start
     * #Hello markdown
     * ## Documentation for /my route
     * @lrd:end
     */
    public function index(MyIndexRequest $request): Resource
    {

测试

./vendor/bin/phpunit

代码检查

./vendor/bin/phpcs --standard=phpcs.xml --extensions=php --ignore=tests/migrations config/ src/

修复代码检查问题

./vendor/bin/php-cs-fixer fix src/
./vendor/bin/php-cs-fixer fix config/

更新日志

初始发布
v1.9 增加了诸如状态码、响应头部、自定义请求头部等改进，并修复了用户报告的问题
v1.10 显示PHP内存使用情况，修复gzip编码问题
v1.12 修复了ID的问题，并支持Laravel 9
v1.13 支持Laravel 9
v1.15 添加了过滤功能，并在异常情况下回退到正则表达式

exclusivedev / laravel-request-docs

维护者

详细信息

README

功能

在Medium上阅读

要求

安装

用法

设计模式

截图

额外

测试

代码检查

更新日志