thewoods96 / doc-shamer
A basic Laravel Artisan command to check an OpenAPI spec against application API routes to summarise doc coverage
Installs: 6 989
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Requires
- php: ^7.4|^8.0
- illuminate/console: ^10.0
- illuminate/support: ^10.0
- symfony/yaml: ^6
Requires (Dev)
- orchestra/testbench: ^6.0
- phpunit/phpunit: ^9.0
README
A basic Laravel Artisan command to check an OpenAPI spec against application API routes to summarise doc coverage.
Installation
You can install the package via composer:
composer require thewoods96/doc-shamer
Usage
Usage:
$ php artisan doc-shamer [options] [arguments]
Options:
--show-coverage: Output tables detailing documented, missing and ignored routes
--dry-run: When set to true the command will always exit with status 0 regardless of doc coverage.
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email 96woods96@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
Laravel Package Boilerplate
This package was generated using the Laravel Package Boilerplate.