Mixing route and query parameters using FOSRestBundle with Symfony Mixing route and query parameters using FOSRestBundle with Symfony symfony symfony

Mixing route and query parameters using FOSRestBundle with Symfony


This question is quite old and you probably found a solution already but since I got here through Google search and know an answer I will contribute.

use Symfony\Bundle\FrameworkBundle\Controller\Controller;use Symfony\Component\HttpFoundation\JsonResponse;use FOS\RestBundle\Request\ParamFetcher;use FOS\RestBundle\Controller\Annotations\QueryParam;use Nelmio\ApiDocBundle\Annotation\ApiDoc;class DefaultController extends Controller{    /**     * Returns a collection of Task     *     * @QueryParam(name="projectId", nullable=true, requirements="\d+")     * @QueryParam(name="name", nullable=true, description="Project Name")     * @QueryParam(name="assignee", nullable=true)     * @QueryParam(name="depth", nullable=true)     *         *     * @param ParamFetcher $paramFetcher     * @ApiDoc()     *     * @return JsonResponse     */    public function cgetTaskAction(ParamFetcher $paramFetcher)    {        foreach ($paramFetcher->all() as $criterionName => $criterionValue) {            // some logic here, eg building query        }        $results = // query database using criteria from above        // this is just a simple example how to return data        return new JsonResponse($results);    }}


Just wanted to post an answer because the original answer only uses QueryParams, and the question was using QueryParams together with RouteParams.

If you want to use route params and query params, you can use the ParamFetcher as first argument to the action and add the route arguments later.

I have not yet found a way to add the route params to the paramFetcher.

/* * @Route("/term/{termId}", requirements={"termId" = "[a-z0-9]+"}) * * @QueryParam(name="limit", requirements="\d+", default="30", description="How many documents to return.") * * @Method("GET") * * @param ParamFetcherInterface $paramFetcher * @param $termId * @return array() */public function getTermFeedAction(ParamFetcherInterface $paramFetcher, $termId) {    // access $termId over the method parameter    // access the @queryparams via the $paramFetcher}