macpaw/symfony-deprecated-routes

Symfony Deprecated Routes Annotations

v1.0.2 2024-05-30 09:41 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|^7.0
• 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

Headers names options

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'