README

无需使用Swagger、OpenApi注释即可生成API文档

~~目前运行在l5-swagger包之上~~

安装

composer require loot/otium

然后运行

php artisan vendor:publish --provider="Loot\Otium\ServiceProvider"

可以在config/otium.php文件中进行设置

在运行命令php artisan l5-swagger:generate后，启动

php artisan loot:generate-docs

由于GET请求不使用FormRequest，otium无法获取文档信息。

为了文档化FormRequest中不存在的参数，请使用注解@param-otium-hint

/**
 * @param-otium-hint {"name": "search", "description": "keyword for search", "in": "query", "required": false}
 */

在需要向文档中添加自定义属性的情况下，请使用@param-otium-extra

/**
 * @param-otium-extra {"ENV": "LOCAL"}
 * @param-otium-extra {"params": {"timeout": 300} }
 */