skqr/hateoas-bundle

GOintegro HATEOAS Bundle

v0.10.10 2016-12-16 15:10 UTC

Requires

• php: >=5.4.0
• doctrine/doctrine-bundle: *
• doctrine/orm: *
• skqr/hateoas: *
• symfony/doctrine-bridge: *
• symfony/framework-bundle: *
• symfony/monolog-bundle: *

Requires (Dev)

• codeception/codeception: 2.2.*
• codeclimate/php-test-reporter: dev-master
• phpdocumentor/phpdocumentor: 2.*
• phpunit/phpunit: *

MIT

• Javier Lorenzana
• GOintegro Devs
• Adolfo Castro Menna

• rest
• api
• doctrine
• HATEOAS
• JSON-API

README

This is a Symfony 2 bundle for the GOintegro HATEOAS lib that uses a Doctrine 2 entity map and a RAML API definition to conjure a HATEOAS API, following the JSON-API specification.

You don't get scaffolds. You get a working API.

You get a working API with features sweeter than a Bobcat's self-esteem.

Try it out

Check out the example app project, so you can feel the magic in your finger tips without much ado.

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require skqr/hateoas-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding the following line in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            new GoIntegro\Bundle\HateoasBundle\GoIntegroHateoasBundle(),
        );
    }
}
?>

Step 3: Add these parameters

# app/config/parameters.yml

# HATEOAS API
api.base_url: "http://api.gointegro.com"
api.url_path: "/api/v2"
api.resource_class_path: "Rest2/Resource"

Step 4: Add these routes

# app/config/routing.yml

# Place it underneath it all - it contains a catch-all route.
go_integro_hateoas:
    resource: "@GoIntegroHateoasBundle/Resources/config/routing.yml"
    prefix: /api/v2

Usage

Check out the library docs for more info.