README

Minimum version enforcement for API services...

Slim Framework 4 usage

See the official Slim Framework 4 middleware documentation for more information.

When using the Slim Framework 4, you can use the Slim4Middleware class to enforce a minimum version for your API.

If a request is made with a version lower than the minimum version, a native Slim HttpException, of code 406 will be thrown. A 406 means "Not Acceptable", which is the correct response code for this situation.

There are two methods of constructing the middleware:

Option 1, using static values

use District5\MinimumVersion\Slim\Slim4Middleware;
use District5\MinimumVersion\Slim\Slim4Checker;

$app->add(
    new Slim4Middleware(
        Slim4Checker::fromValues(
            '1.0.0', // Minimum version to accept
            ['0.9.9', '1.0.0'], // Explicitly allowed versions
            'X-Api-Version' // Header name to check version against, defaults to 'X-Version'
        )
    )
);

Option 2, using environment variables

use District5\MinimumVersion\Slim\Slim4Middleware;
use District5\MinimumVersion\Slim\Slim4Checker;

$app->add(
    new Slim4Middleware(
        Slim4Checker::fromEnv(
            'MINIMUM_VERSION', // Environment variable name for minimum version, e.g. '1.0.0'
            'ALLOWED_VERSIONS', // Environment variable name for allowed versions, comma-separated, e.g. '0.0.9, 1.0.0'
            Slim4Middleware::VERSION_HEADER // This is the default value of 'X-Version'. The header name to check version
        )
    )
);

Install with composer...

composer require district5/minimum-version

Testing...

composer install
./vendor/bin/phpunit