Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stanlemon/rest-bundle

This bundle provides REST endpoints for Doctrine entities.
https://github.com/stanlemon/rest-bundle

Last synced: 3 months ago
JSON representation

This bundle provides REST endpoints for Doctrine entities.

Awesome Lists containing this project

README

        

LemonRestBundle
============

[![Build Status](https://travis-ci.org/stanlemon/rest-bundle.png?branch=master)](http://travis-ci.org/stanlemon/rest-bundle)

This bundle provides REST endpoints for Doctrine entities. It is a highly opinionated, convention driven solution to rapidly deploying a REST API. It relies on the strengths of libraries like [JMS Serializer](http://jmsyst.com/libs/serializer), [Will Durands Content Negotiation library](http://williamdurand.fr/Negotiation/) and the [Doctrine Object Relation Mapper library](http://www.doctrine-project.org/projects/orm.html) to make assumptions and drive your REST API off of convention.

If you are looking for an extremely flexible way to build REST APIs this library is not for you, and I suggest you take a look at the fantastic work being done on the [Friends of Symfony REST Bundle](https://github.com/FriendsOfSymfony/FOSRestBundle).

Authors
-------

* Stan Lemon

Changes
-------

Details about changes from version to version are stored in `CHANGELOG.md`

Documentation
-------------

Documentation is stored in the `Resources/doc/index.md` file in this bundle:

* [Read the documentation](Resources/doc/index.md)

Demo
-------------

A demo application is available at https://github.com/stanlemon/rest-demo-app

You can also try it yourself online at http://restdemo-stanlemon.rhcloud.com

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

All the installation instructions are located in the [documentation](Resources/doc/index.md).

Reporting an issue or a feature request
---------------------------------------

Issues and feature requests are tracked in the [Github issue tracker](https://github.com/stanlemon/rest-bundle/issues).

Contributing
---------------------------------------

Go for it! Please open a PR against the _develop_ branch and make sure to, at the very least, include a functional test covering your work. Or even better, full functional and unit tests!