通过 
搜索
搜索targettech / laravel-api-doc-generator
自动从表单请求规则、控制器和路由生成 Laravel API 文档
dev-main
2022-09-15 13:15 UTC
Requires
- php: ^7.3|^7.4|^8.0|^8.1
- illuminate/contracts: ^9.26.1
- phpdocumentor/reflection-docblock: ^5.3
- spatie/laravel-package-tools: ^1.4.3
Requires (Dev)
- brianium/paratest: ^6.6.3
- nunomaduro/collision: ^v6.0.0
- orchestra/testbench: ^7.7.0
- phpunit/phpunit: ^9.3
- spatie/laravel-ray: ^1.30.0
- vimeo/psalm: ^4.8
This package is auto-updated.
Last update: 2024-09-15 17:50:46 UTC
README
无需编写注解即可自动为 Laravel 生成 API 文档。
要求
安装
您可以通过 composer 安装此包
composer require targettech/laravel-api-doc-generator --dev
您可以使用以下命令发布配置文件
php artisan vendor:publish --tag=request-docs-config
使用方法
在 /request-docs/ 上通过浏览器查看
或生成静态 HTML
php artisan lrd:generate
文档 HTML 生成在 docs/ 目录内。
设计模式
为了让此插件正常工作，您需要在控制器内部注入请求类，并遵循设计模式。此外，您还可以在控制器方法中使用 Markdown 格式编写额外的文档。
屏幕截图
生成的 API 文档
尝试 API
测试
./vendor/bin/phpunit
变更日志
- 首次发布