pgs-soft/restfony-bundle

Symfony3 bundle to implement REST crud

PGS Software / Restfony Bundle

, _(*1)

Bundle to assist with creating classes for Doctrine Entity with aim to speed up creating RESTful APIs., _(*2)

Installation

Require the bundle with composer:, _(*3)

    composer require pgs-soft/restfony-bundle

Enable the bundle (with dependent bundles) in the kernel:, _(*4)

    <?php
    // app/AppKernel.php

    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Pgs\RestfonyBundle\PgsRestfonyBundle(),
            new FOS\RestBundle\FOSRestBundle(),
            new JMS\SerializerBundle\JMSSerializerBundle(),
            new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
            new Bazinga\Bundle\HateoasBundle\BazingaHateoasBundle(),
            new Knp\Bundle\PaginatorBundle\KnpPaginatorBundle(),
            new Lexik\Bundle\FormFilterBundle\LexikFormFilterBundle(),
            // ...
        );
    }

Prepare config for Restfony and FOSRestBundle:, _(*5)

    # app/config/rest.yml

    jms_serializer:
        handlers:
            datetime:
                default_format: 'Y-m-d\TH:i:sP'
        property_naming:
            separator: null
            lower_case: false
    fos_rest:
        param_fetcher_listener: true
        body_listener: true
        format_listener: true
        routing_loader:
            default_format: json
            include_format: false
        serializer:
            serialize_null: true
    pgs_restfony:
        modules:

and include it in the main config:, _(*6)

    # app/config/config.yml

    imports:
    # ...
        - { resource: rest.yml }

    # ...

Add routing definition, e.g.:, _(*7)

    # app/config/routing.yml 

    # ...

    appbundle_rest:
        resource: "@AppBundle/Resources/config/rest_routing.yml"
        prefix:   /api/

Usage

Having an entity run command:, _(*8)

    bin/console pgs:generate:crud MyEntity

provide entity shortcut name (e.g. AppBundle:MyEntity), decide about adding "write" actions and generation of routing., _(*9)

New files will be generated: - Controller/MyEntityController.php - controller with RESTful actions and ApiDoc - Form/Filter/MyEntityFilterType.php - form filter class - Form/Type/MyEntityType.php - form type class - Manager/MyEntityManager.php - empty class to manage repository - Manager/MyEntityManagerInterface.php - interface for manager from above - Repository/MyEntityRepository.php - empty repository class - Resources/config/serializer/Entity.MyEntity.yml - config for JMS Serializer - Tests/MyEntityControllerTest.php - set up of tests for generated actions, _(*10)

And configs will be updated: - rest.yml - module for MyEntity will be added - rest_routing.yml - entry for MyEntity will be added, _(*11)

API Doc

If needed you can add NelmioApiDocBundle API documentation route, e.g.:, _(*12)

    # app/config/routing_dev.yml

    # ...

    NelmioApiDocBundle:
        resource: "@NelmioApiDocBundle/Resources/config/routing.yml"
        prefix:   /api/doc

Authors

• Lech Groblewicz lgroblewicz@pgs-soft.com
• Michał Sikora

Contributors

• Tomasz Brzeziński tbrzezinski@pgs-soft.com
• Karol Joński kjonski@pgs-soft.com
• Krzysztof Maczkowiak kmaczkowiak@pgs-soft.com
• Grzegorz Mandziak gmandziak@pgs-soft.com
• Kamil Purzyński kpurzynski@pgs-soft.com
• Dariusz Rzeźnik drzeznik@pgs-soft.com
• Jakub Werłos jwerlos@pgs-soft.com
• Krzysztof Wojtas kwojtas@pgs-soft.com