PHPackages                             brightmarch/restful-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. brightmarch/restful-bundle

AbandonedSymfony-bundle[API Development](/categories/api)

brightmarch/restful-bundle
==========================

A useful bundle for easily creating RESTful resources.

191.6k2PHP

Since Jun 10Pushed 11y ago3 watchersCompare

[ Source](https://github.com/brightmarch/BrightmarchRestfulBundle)[ Packagist](https://packagist.org/packages/brightmarch/restful-bundle)[ RSS](/packages/brightmarch-restful-bundle/feed)WikiDiscussions master Synced 4d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Symfony2 RESTful Bundle
=======================

[](#symfony2-restful-bundle)

This is a very small but powerful Symfony2 bundle for quickly building RESTful resources (specifically, HTTP APIs).

Installation
------------

[](#installation)

Installation is relatively easy. It requires three steps. Start by adding the right dependency to your `composer.json` file and install the new bundle.

```
"brightmarch/restful-bundle": "1.0.0"
```

You can safely assume that what is in `master` is always up to date.

```
$ composer.phar install brightmarch/restful-bundle
```

Once installed, add it to `app/AppKernel.php` in the main `$bundles` array. You do not want this to be part of the dev system only.

```
$bundles = array(
    new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
    // ... other bundles ... //
    new Brightmarch\Bundle\RestfulBundle\BrightmarchRestfulBundle(),
);
```

Installation is complete, you are now ready to begin building a RESTful resource.

Usage
-----

[](#usage)

To start, you will most likely want to start with your own bundle. Each resource that you want to work with this bundle must extend the `Brightmarch\Bundle\RestfulBundle\Controller\RestfulController` controller.

### Sample Controller

[](#sample-controller)

```