feat: defaults parameters

[Maxcastel]

Q	A
Branch?	main
Tickets	Closes #7509
License	MIT
Doc PR	api-platform/docs#...

Description

This PR allows to define global default parameters that are applied to all resources instead of configuring the parameter individually on each resource.

Before

#[ApiResource(
    operations: [
        new GetCollection(
            parameters: [
                new HeaderParameter(
                    key: 'X-API-Token',
                    required: true,
                    description: 'API Token',
                ),
            ],
        ),
    ],
)]
class Book
{

}

#[ApiResource(
    operations: [
        new GetCollection(
            parameters: [
                new HeaderParameter(
                    key: 'X-API-Token',
                    required: true,
                    description: 'API Token',
                ),
            ],
        ),
    ],
)]
class Author
{

}

After

api_platform:
    defaults:
        parameters:
            ApiPlatform\Metadata\HeaderParameter:
                key: 'X-API-Token'
                required: true
                description: 'API Token'

#[ApiResource]
class Book
{

}

#[ApiResource]
class Author
{

}

Other exemple with two Parameter

api_platform:
    title: My API
    version: 1.0.0
    defaults:
        parameters:
            ApiPlatform\Metadata\HeaderParameter:
                key: 'X-API-Token'
                required: true
                description: 'API authentication token'
            
            ApiPlatform\Metadata\QueryParameter:
                key: 'api_version'
                required: false
                description: 'API version'

[soyuka]

Couldn't you use the defineDefault method of this class? It makes this automatic.

[Maxcastel]

done in 1da905e

[soyuka]

Could you use the automatic method for configuration? the rest is awesome!

[Maxcastel]

Also changed the priority of DefaultParametersResourceMetadataCollectionFactory (150 to 1001) so that it is higher than ParameterValidationResourceMetadataCollectionFactory (1000) and therefore executed before it, otherwise, it doesn’t work (tested on a real project by changing the version of "api-platform/core" to "dev-feature/config-defaults-parameters", and it works).

Currently, when changing the priority of DefaultParametersResourceMetadataCollectionFactory, all tests still pass. Should we add a functional test that fails if the priority is set to 150 (or any value lower than 1001)? How could we test this behavior?

[soyuka]

It's a hard problem + there's no bc-layer on priorities... I suggest to merge the code of your default factory to the one handling parameters. I know it'll be more code in a class but it keeps a better responsibility over this in my opinion.

[soyuka]

create a an array and name convert all the keys so that you can call __construct with arguments (programatically) we know they match as the configuration does it the other way around

[Maxcastel]

done in 87829ee