alterway/rest-problem-bundle

way to respect Problem Details for HTTP APIs RFC (http://tools.ietf.org/html/draft-nottingham-http-problem-03)

 RestProblemBundle

Bundle to manage Problems in API with Symfony2., _(*1)

, _(*2)

This bundle follows the Problem Details for HTTP APIs recommandation., _(*3)

 Installation

Edit your composer.json:, _(*4)

"require": {
    "alterway/rest-problem-bundle" : "master"
}

And run Composer:, _(*5)

php composer.phar update alterway/rest-problem-bundle

Enable your bundle in your AppKernel.php:, _(*6)

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Alterway\Bundle\RestProblemBundle\AwRestProblemBundle(),
    );
}

Usage

use Alterway\Bundle\RestProblemBundle\Response\ProblemResponse;
use Alterway\Bundle\RestProblemBundle\Problem;

public function demoAction(Request $request)
{

    $form = // (...)

    $form->bind($request);
    if (!$form->isValid()) {
        $problem = new Problem\InvalidQueryForm($form);
        return new ProblemResponse($problem, 403);
    }
}

 Usage with annotations

Remember to enable annotations :, _(*7)

sensio_framework_extra:
router:  { annotations: true }
request: { converters: true }
view:    { annotations: true }
cache:   { annotations: true }

And to register the autoloader in your app/autoload.php file:, _(*8)

Doctrine\Common\Annotations\AnnotationRegistry::registerLoader(array($loader, 'loadClass')); 

This will send an application/api-problem+json header:, _(*9)

use Alterway\Bundle\RestProblemBundle\Response\ProblemResponse;
use Alterway\Bundle\RestProblemBundle\Controller\Annotations\Problem;

/**
* @Problem
*/
public function demoAction(Request $request)
{

    $form = // (...)

    $form->bind($request);
    if (!$form->isValid()) {
        return new Problem\InvalidQueryForm($form);
    }
}

Problem's types

You need to create your own problem types. There are by default the following problems:, _(*10)

• Problem\InvalidQuery
• Problem\InvalidQueryForm
• ...

Todo

Add controllers and route to provide problemType, _(*11)

 Contribute

Install dev dependencies:, _(*12)

php composer.phar update --dev

Run Behat:, _(*13)

./vendor/bin/behat @AwRestProblemBundle

Copyright

Copyright (c) 2013 La Ruche Qui Dit Oui!. See LICENSE for details., _(*14)

Contributors

• Lead: Jean-François Lépine (Halleck45)
• Developer: Antoine Lévêque (gh0stonio)

Sponsors

• Alter Way
• La Ruche Qui Dit Oui!