shortcodes/annotation-generator

生成注释的控制台命令

维护者

详细信息

github.com/shortcodes/annotation-generator

源代码

问题

安装次数: 3,119

依赖者: 0

建议者: 0

安全: 0

星标: 1

关注者: 0

分支: 0

开放问题: 0

1.2.1 2021-11-29 18:58 UTC

Requires

  • php: >=7.0.0

mit 85225b526519f47eb2ad451388732487d6392b32

  • Roman Szymanski <roman.szymanski.woop@shortcodes.pl>

This package is auto-updated.

Last update: 2024-09-29 05:28:35 UTC

README

注释生成器是一个用于为 Swagger 3.0 文档生成注释的 php artisan 命令

# 安装

composer require shortcodes/annotation-generator

用法

在 app/Console/Kernel.php 中注册命令

protected $commands = [
    GenerateAnnotations::class
];

然后你可以使用该命令

php artisan make:annotation Product --tag="product"

选项 --tag 负责生成带有正确 Swagger 3.0 标签的注释，并且是必填项

### 输出

命令在目录 app/Swagger/Actions 中创建文件 Index.php、Show.php、Store.php、Update.php 和 Delete.php，带有 Swagger 3.0 注释，并在 app/Swagger/Models 中创建名为 Product.php 的模型示例属性

可以使用选项 --nomodel 排除模型的创建