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

• Connor Woods
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.