How can I use identifier as a query parameter in api-platform?

Question

I am using api-platform 2.6 with symfony 6. I have a model

use ApiPlatform\Core\Annotation\ApiResource;
use ApiPlatform\Core\Annotation\ApiProperty;

#[ApiResource(
    itemOperations: [
        'get' => [
            'path' => '',
        ],
    ]
)]
class SomeName
{
    #[ApiProperty(identifier: true)]
    public string $pathInfo;

$pathInfo is a identifier and can take values of the form like "/some/path/.../". I would like to use this api method like

/some-name/?pathInfo=/some/path/.../

where $pathInfo is a query (GET) parameter. How can I do this?

I have tried this

    itemOperations: [
        'get' => [
            'path' => '?pathInfo={pathInfo}',
        ],
    ],

but I get error "No route found for..." and I don't like that in OpenApi documentation this api method looks like "/some-name?pathInfo={pathInfo}"

David Valverde Pareja · Accepted Answer · 2023-02-16 19:03:03Z

0

use ApiPlatform\Core\Annotation\ApiResource;
use ApiPlatform\Core\Annotation\ApiProperty;

#[ApiResource(
    itemOperations: [
        'get' => [
            'path' => '/some-name',
            'openapi_context' => [
                'parameters' => [
                    [
                        'in' => 'query',
                        'name' => 'pathInfo',
                        'required' => true,
                        'schema' => [
                            'type' => 'string',
                        ],
                        'description' => 'The path information',
                    ],
                ],
            ],
        ],
    ]
)]

answered Feb 16, 2023 at 19:03

David Valverde Pareja

11 bronze badge

Sign up to request clarification or add additional context in comments.

2 Comments

Николай Over a year ago

This just outputs the second pathInfo field in the Open Api documentation. And the api method itself returns an error "Invalid identifier value or configuration.". But thanks for the answer.

Community Over a year ago

As it’s currently written, your answer is unclear. Please edit to add additional details that will help others understand how this addresses the question asked. You can find more information on how to write good answers in the help center.

Collectives™ on Stack Overflow

How can I use identifier as a query parameter in api-platform?

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related