{"repo":"RonasIT/laravel-swagger","free":true,"listed":false,"github":"https://github.com/RonasIT/laravel-swagger","clone":"git clone https://github.com/RonasIT/laravel-swagger.git","description":"Laravel-Swagger is a fully automate tool which allows to generate and save swagger-based documentation after successful completing your application's feature tests.","language":"PHP","stars":180,"topics":["laravel","swagger-documentation","automation","openapi","php","swagger"],"license":"MIT","category":"workflow-automation","readme_excerpt":"Laravel Swagger plugin Comparison to another documentation generators LaravelSwagger Scramble ---------------------------------------------------- ------------------------ ---------------------------------------------- Force developers to write tests :white check mark: :x: Guarantee that API works :white check mark: :x: Works with any route types covered by tests :white check mark: :x: Generate response schema using JSON Resource class :x: :white check mark: Runtime documentation generation :x: :white check mark: Introduction This plugin is designed to generate documentation for your REST API during the passing PHPUnit tests. Installation 1. Install the package using the following command: composer require ronasit/laravel-swagger Note For Laravel 5.5 or later the package will be auto-discovered. For older versions add the AutoDocServiceProvider to the providers array in config/app.php as follow: 2. Run 3. Add \\RonasIT\\AutoDoc\\Http\\Middleware\\AutoDocMiddleware::class middleware to the global HTTP middleware list bootstrap\\app.php : 4. Add \\RonasIT\\AutoDoc\\Traits\\AutoDocTestCaseTrait trait to tests/TestCase.php 5. Configure documentation saving using one of the next ways: - Add SwaggerExtension to the block of your phpunit.xml . Please note that this way will be removed after updating PHPUnit up to 10 version (https://github.com/sebastianbergmann/phpunit/issues/4676) - Call php artisan swagger:push-documentation console command after the tests stage in your CI/CD configuration ","default_branch":null,"files":null,"tree":[],"storefront":"/r/RonasIT","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/RonasIT/laravel-swagger/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}