Symfony API REST as Service

Development environment (optional)

Vagrant & Ansible:

• https://github.com/albertcolom/custom-ansible-vagrant

Bundles

• FOSRestBundle
• JMSSerializerBundle
• NelmioApiDocBundle
• NelmioCorsBundle
• LiipFunctionalTestBundle

Installation

Clone this repository

$ git clone git@github.com:albertcolom/symfony-api-rest-as-service

Install dependencies

$ composer install

Config parameters

$ app/config/parameters.yml

Create Database

$ app/console doctrine:database:create

Load Fixtures

$ app/console doctrine:fixtures:load

List of services

src/AppBundle/Resources/config/services.yml

services:
    util.inflector:
      class: AppBundle\Util\Inflector\NoPluralize

    app.request.normalize.sort:
      class: AppBundle\Application\Normalizer\NormalizeSort

    app.request.normalize.type:
      class: AppBundle\Application\Normalizer\NormalizeType

    app.request.normalize.data:
      class: AppBundle\Application\Normalizer\RequestNormalizerData

    app.request.normalize:
      class: AppBundle\Application\Normalizer\RequestNormalizer
      arguments: ['@app.request.normalize.sort', '@app.request.normalize.type','@app.request.normalize.data']

    app.fos_rest.view.view:
      class: FOS\RestBundle\View\View
      factory: [FOS\RestBundle\View\View, create]

    app.rest.view:
      class: AppBundle\Application\Rest\v1\RestView
      arguments: ['@fos_rest.view_handler','@app.fos_rest.view.view']

    app.serializer.fields.exclusion:
      class: AppBundle\Application\Serializer\FieldsListExclusionStrategy

    app.jms.serializer.context:
      class: JMS\Serializer\SerializationContext

    app.rest.controller:
      class: AppBundle\Application\Rest\v1\RestController
      arguments: ['@doctrine.orm.entity_manager','@app.rest.view','@app.request.normalize','@form.factory','@app.serializer.fields.exclusion','@app.jms.serializer.context']

    app.controller.category:
      class: AppBundle\Controller\v1\CategoryRESTController
      arguments: ['@app.rest.controller']

    app.controller.product:
      class: AppBundle\Controller\v1\ProductRESTController
      arguments: ['@app.rest.controller']

Example methods

GET Entity

<?php
    /**
     *
     * @ApiDoc(
     *  resource=true,
     *  description="Get entity instance",
     *  statusCodes = {
     *      200 = "Returned when successful",
     *      404 = "Returned when not found"
     *  }
     * )
     *
     * @Annotations\QueryParam(name="fields", nullable=true, array=true,
     *     description="Fields to return. Must be an array ie. &fields[entityA]=id,name&fields[entityB]=id")
     *
     * @param Entity $entity
     * @param ParamFetcherInterface $paramFetcher
     * @return Response
     */
    public function getAction(Entity $entity, ParamFetcherInterface $paramFetcher)
    {
        return $this->restController->get($entity, $paramFetcher->all());
    }

GET Collection

<?php

    /**
     *
     * @ApiDoc(
     *   resource = true,
     *   description="Get Collection",
     *   statusCodes = {
     *     200 = "Returned when successful",
     *     404 = "Returned when not found"
     *   }
     * )
     *
     * @Annotations\QueryParam(name="offset", requirements="\d+", default=0, nullable=true,
     *     description="Offset from which to start listing pages ie. offset=1")
     * @Annotations\QueryParam(name="limit", requirements="\d+", default=20,
     *     description="How many pages to return ie. limit=20")
     * @Annotations\QueryParam(name="sort", nullable=true,
     *     description="JsonApi: Order by fields ie. &sort=-field1,field2 (-field1: DESC | field2: ASC)")
     * @Annotations\QueryParam(name="fields", nullable=true, array=true,
     *     description="Fields to return. Must be an array ie. &fields[entityA]=id,name&fields[entityB]=id")
     *
     * @param ParamFetcherInterface $paramFetcher
     * @return Response
     */
    public function cgetAction(ParamFetcherInterface $paramFetcher)
    {
        return $this->restController->getCollection(Entity::class, $paramFetcher->all());
    }

POST

<?php

    /**
     *
     * @ApiDoc(
     *  resource=true,
     *  description="Create entity",
     *  input = "AppBundle\Form\EntityType",
     *  statusCodes = {
     *      201 = "Returned when is created",
     *      400 = "Returned when the form has errors"
     *  }
     * )
     *
     * @param Request $request
     * @return Response
     */
    public function postAction(Request $request)
    {
        return $this->restController->post(new Entity(), EntityType::class, $request, 'url_redirect');
    }

PUT

<?php

    /**
     *
     * @ApiDoc(
     *  resource=true,
     *  description="Update entity",
     *  input = "AppBundle\Form\EntityType",
     *  statusCodes = {
     *      201 = "Returned when is created",
     *      204 = "Returned when successful",
     *      400 = "Returned when the form has errors"
     *  }
     * )
     *
     *
     * @param Request $request
     * @param $entity
     * @return Response
     */
    public function putAction(Request $request, Entity $entity)
    {
        return $this->restController->put($entity, EntityType::class, $request, 'url_redirect');
    }

PATCH

<?php

    /**
     *
     * @ApiDoc(
     *  resource=true,
     *  description="Update entity",
     *  input = "AppBundle\Form\EntityType",
     *  statusCodes = {
     *      201 = "Returned when is created",
     *      204 = "Returned when successful",
     *      400 = "Returned when the form has errors"
     *  }
     * )
     *
     *
     * @param Request $request
     * @param $entity
     * @return Response
     */
    public function putAction(Request $request, Entity $entity)
    {
        return $this->restController->patch($entity, EntityType::class, $request, 'url_redirect');
    }

API documentation

URL

http://domain/web/app_dev.php/api/doc

Test

$ bin/phpunit -c  app

CodeSniffer PSR-2

$ bin/phpcs --standard=PSR2 src