ferror/openapi-coverage

0.1.0-beta 2024-01-03 20:40 UTC

Requires

• php: ^8.2
• nelmio/api-doc-bundle: ^4.12
• symfony/console: ^5.4 || ^6.4
• symfony/dependency-injection: ^5.4 || ^6.4
• symfony/http-kernel: ^5.4 || ^6.4
• symfony/routing: ^5.4 || ^6.4

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-symfony: ^1.3
• phpunit/phpunit: ^10.5

MIT

README

Open API Coverage Calculator Symfony Bundle

The Open API Coverage Calculator Symfony Bundle enables you to track another system metric - The API Documentation Coverage. The library extracts your application API endpoints via Symfony Routing and checks them against NelmioAPIDocBundle, the most popular library for Open API Specification in the Symfony ecosystem.

Installation

composer require --dev ferror/openapi-coverage

// bundles.php

return [
    Ferror\OpenapiCoverage\Symfony\Bundle::class => ['dev' => true, 'test' => true],
];

Usage

php bin/console ferror:check-openapi-coverage

You can also specify the --threshold or (--t) option to define coverage level below which the command will fail.

php bin/console ferror:check-openapi-coverage --threshold 0.70

Example Result

Open API coverage: 75%
+- Missing documentation -+
| path          | method  |
+---------------+---------+
| /products/:id | get     |
+---------------+---------+