macpaw/symfony-deprecated-routes

Symfony Deprecated Routes Annotations

v1.0.0 2024-02-19 09:59 UTC

Requires

• php: ^8.1
• phpstan/phpstan-symfony: ^1.3
• symfony/config: ^6.4|^7.0
• symfony/dependency-injection: ^6.4|^7.0
• symfony/event-dispatcher: ^6.4
• symfony/http-kernel: ^6.4|^7.0
• symfony/routing: ^6.4|^7.0

Requires (Dev)

• phpunit/phpunit: ^10.5
• squizlabs/php_codesniffer: ^3.8
• symfony/browser-kit: ^6.0
• symfony/framework-bundle: ^6.4|^7.0
• symfony/yaml: ^6.4|^7.0

MIT

README

Symfony Deprecated Routes Bundle offers to mark some api routes as deprecated.

Installation

Use Composer to install the bundle:

composer require macpaw/symfony-messenger-bundle

Setup bundle

Enable the bundle by adding it to the list of registered bundles in config/bundles.php

// config/bundles.php

return [
            Macpaw\SymfonyDeprecatedRoutes\DeprecatedRoutesBundle::class => ['all' => true],
        // ...
    ];

Extend bundle options

This bundle provide configuration for marking routes

Option	Type	Description	Default value
headers	array	Deprecation headers names
isDisabled	bool	Disable add marks for routes	false
headers	array	Deprecation headers names
isSinceRequired	bool	If true enable validation for set route attribute	false

Headers names options

Name	Description
deprecatedMessageName	Deprecated message info header name
deprecatedFromName	Start deprecation date
deprecatedSinceName	The date of the removal route

Full config example with default values

config/packages/deprecated-routes.yaml

deprecated-routes:
    isSinceRequired: false
    isDisabled: false

    headers:
      deprecatedMessageName: 'X-DEPRECATED'
      deprecatedFromName: 'X-DEPRECATED-FROM'
      deprecatedSinceName: 'X-DEPRECATED-SINCE'