kr0lik / laravel-dto-to-swagger
从 DTO 和动作返回类型生成 Swagger。
1.0.2
2024-08-23 14:41 UTC
Requires
- php: ^8.2
- laravel/framework: ^10.0|^11.0
- phpdocumentor/reflection-docblock: ^5.3
- symfony/property-info: ^7.1
- zircote/swagger-php: ^4.8
Requires (Dev)
- icanhazstring/composer-unused: ^0.8.11
- kr0lik/php-cs-fixer: ^2.0
- kr0lik/phpstan-rules: ^2.0
Suggests
- spatie/laravel-data: ^3.11
README
自动从 Laravel 路由和强类型数据生成 Swagger 文档(使用 DTO 作为请求和响应数据)。
您可以将 laravel-dto-to-swagger 与 spatie/laravel-data 包一起使用,Swagger 将完全自动化且非常简单。
安装
$ composer require kr0lik/laravel-dto-to-swagger
设置非常简单,只需将服务提供者添加到您的 app.php 配置文件中。
Kr0lik\DtoToSwagger\DtoToSwaggerServiceProvider::class,
您还需要发布配置
$ php artisan vendor:publish --provider="Kr0lik\DtoToSwagger\DtoToSwaggerServiceProvider"
使用
- 根据您的需求更新 config/swagger.php 文件。
- 检查或修复您的 Controller/Action 以使用字符串类型和 DTO
- 运行以下命令以自动生成 Swagger 文档
$ php artisan swagger:generate
此命令将生成一个 swagger.yaml 文件,其中包含 Swagger 文档。
示例
查看示例文件夹