Генерация документации API без использования Swagger, OpenApi комментариев в коде
Работает поверх пакета l5-swagger (пока что)
composer require loot/otium
Then run:
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} }
*/
Roadmap доступен тут https://trello.com/b/XNh0t5g0/otiums-roadmap