How to pass multiple parameter in a GET request inside a API symfony2?

Question

I am using a FOSRestBundle and I am pretty new in Symfony.

I've been following some exemples I've seen but I can't add more than one parameter in the request.

For example

/**
     *  
     * @param  string $id Identifier
     * @return [type]     [description]
     *
     * @ApiDoc()
     */
    public function getProductsAction($id)
    {
        return myfunction($id);
    }

works fine, but if I want to do a variation like this:

 /**
     *  
     * @param  string $id Identifier
     * @return [type]     [description]
     *
     * @ApiDoc()
     */
    public function getProductsAction($id, $month)
    {
        return myfunction($id, $month);
    }

It doesn't work. It identifies only the $id

There is any limitation I am not aware? or some extra configuration beyond the simple modification I did?

lolmx · Accepted Answer · 2016-11-25 18:14:21Z

1

When you write

/**
 *  
 * @param  string $id Identifier
 * @return [type]     [description]
 *
 * @ApiDoc()
 */
public function getProductsAction($id)
{
    return myfunction($id);
}

it's equivalent to

use FOS\RestBundle\Controller\Annotations\Get;

/**
 * @Get("/products/{id}")
 * @param  string $id Identifier
 * @return [type]     [description]
 *
 * @ApiDoc()
 */
public function getProductsAction($id)
{
    return myfunction($id);
}

Symfony maps automatically the route and parameter.

But when you write

/**
 *  
 * @param  string $id Identifier
 * @return [type]     [description]
 *
 * @ApiDoc()
 */
public function getProductsAction($id, $month)
{
    return myfunction($id, $month);
}

Symfoy doesn't know what to do with your $month parameter, you need to tell it

use FOS\RestBundle\Controller\Annotations\Get;

/**
 * @Get("/products/{id}/{month}")
 * @param  string $id Identifier
 * @return [type]     [description]
 *
 * @ApiDoc()
 */
public function getProductsAction($id, $month)
{
    return myfunction($id, $month);
}

edited Nov 25, 2016 at 18:14

answered Nov 25, 2016 at 15:04

lolmx

5216 silver badges18 bronze badges

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

2 Comments

Matheus Oliveira Over a year ago

The @get is an annotation from which symfony component? I am getting a non imported use statement.

lolmx Over a year ago

@MatheusOliveira it's the annotation from FOSRestBundle, i've included it in the answer :)

Collectives™ on Stack Overflow

How to pass multiple parameter in a GET request inside a API symfony2?

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