im0rtality/rest-api-bundle

REST API Bundle

REST API Bundle

This bundle is a RESTful API building tool making process as fast as possible. For example, to achieve simple CRUD you only need to:, _(*1)

1. Have your entities (for now only Doctrine is supported)
2. Configure bundle

, _(*2)

Installation

1. Install via Composer

$ composer require "im0rtality/rest-api-bundle:dev-master"

2. Activate it

Enable bundle in kernel:, _(*3)

// app/AppKernel.php
<?php

public function registerBundles()
{
    $bundles = array(
        // ...

        // this bundle depends on following two
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new FOS\UserBundle\FOSUserBundle(),

        new Im0rtality\ApiBundle\Im0rtalityApiBundle(),
    );
}

3. Register routes

Add following to your routing configuration:, _(*4)

im0rtality_api:
    resource: "@Im0rtalityApiBundle/Resources/config/routing.yml"
    prefix:   /api

4. Configure FOSUserBundle's security

Described in details https://github.com/FriendsOfSymfony/FOSUserBundle/blob/1.3.x/Resources/doc/index.md#step-4-configure-your-applications-securityyml, _(*5)

5. Disable security for API route

Add following to your security configuration:, _(*6)

security:
    role_hierarchy:
        # Simple admin/user configuration
        ROLE_OWNER:       ROLE_USER
        ROLE_ADMIN:       ROLE_OWNER

    access_control:
        # API bundle takes care of security
        - { path: ^/api, role: IS_AUTHENTICATED_ANONYMOUSLY }

Heads-up! ROLE_OWNER should not be set on user explicitly. It is added to user roles (in bundle scope only) internally., _(*7)

Configuration

You can find minimal sample app with configuration and everything in tests directory of this project (maintained for behat tests), _(*8)

Example configuration:, _(*9)

# app/config/config.yml

im0rtality_api:
    acl: api_acl.yml
    mapping:
        user: 'Acme\DemoBundle\Entity\User'
    data:
        type: orm
    ownership:
        'Acme\DemoBundle\Entity\User': id

Testing

Most of code is covered with PHPSpec internally and other part is coverted externaly with Behat. To run tests you need to execute following:, _(*10)

# install vendors
$ composer install
$ cd test; composer install

# run the tests
$ bin/phpspec run
$ cd test; bin/behat