通过 
搜索
搜索omid-zahed / laravel-request-docs
从请求规则、控制器和路由自动生成 Laravel 文档
dev-master
2022-06-13 10:03 UTC
Requires
- php: ^7.3|^7.4|^8.0
- illuminate/contracts: ^8.37
- spatie/laravel-package-tools: ^1.4.3
Requires (Dev)
- brianium/paratest: ^6.2
- nunomaduro/collision: ^5.3
- orchestra/testbench: ^6.15
- phpunit/phpunit: ^9.3
- spatie/laravel-ray: ^1.23
- vimeo/psalm: ^4.8
This package is auto-updated.
Last update: 2024-09-13 15:13:48 UTC
README
无需编写注释即可自动生成 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
测试
./vendor/bin/phpunit
变更日志
- 初始发布