defa-public / swagger-code-gen
基于 Swagger-方案的 API 生成库
此软件包的官方仓库似乎已不存在,因此该软件包已被冻结。
dev-master
2018-12-24 16:19 UTC
Requires
- php: ~7.0
Requires (Dev)
- nette/php-generator: ^3.0
- phpunit/phpunit: ^5.4
- symfony/console: ~3.4.20
This package is auto-updated.
Last update: 2022-03-25 20:14:17 UTC
README
基于 Swagger-方案的控制器、验证器、路由(基础 API)生成器
安装
Composer
$ composer require defa-public/swagger-code-gen
功能
- 生成路由(保留旧路由版本)
- 生成验证器
- 生成控制器,并与
`Response::class`
绑定,以及与应用程序的输入端口(例如:HttpPort\\Auth::login
)
驱动程序
用于添加对各种框架的支持。
当前驱动程序
- Lumen ^5.5 (lumen5) - 测试版
- Laravel ^5.5 (laravel5) - 内测版
- Symfony ^3 (symfony3) ?- 开发中
- Symfony ^4 (symfony4) - 开发中
- Zend Expressive (FastRouter/(Pimple/Aura.Di)/Twig/Whoops) - ?- 开发中(有疑问)
要创建自己的驱动程序,需要从 `Defa\SwaggerCodeGen\Driver`
类继承,并在配置对象 `Defa\SwaggerCodeGen\Config\BaseConfig`
的相应字段中指定它。
配置
通过创建 `Defa\SwaggerCodeGen\Config\BaseConfig`
类的对象,并将此对象传递给 `Defa\SwaggerCodeGen\Scheme`
类的对象来实现配置。
控制台命令
必选参数
`scheme-path=path/to/scheme`
- 方案路径(可以指定 uri) *必选
可选参数(必须指定其中一个)
`--validators`
- 只生成验证器`--all`
- 生成所有必要的类`--refresh`
- 删除并重新创建所有创建的(与生成匹配)文件/文件夹
示例
<?php
//Example Code