helmich/flow-restapi-example

Example application for REST webservices with TYPO3 Flow

v1.0.0 2015-01-09 16:49 UTC

Requires

• doctrine/migrations: @dev
• helmich/flow-resttools: dev-master
• symfony/serializer: ~2.6
• typo3/flow: 2.3.*
• typo3/welcome: 2.3.*

Requires (Dev)

• mikey179/vfsstream: 1.2.*
• phpunit/phpunit: 4.0.*
• typo3/buildessentials: 2.3.*
• typo3/kickstart: 2.3.*

Suggests

• ext-pdo_sqlite: For running functional tests out-of-the-box this is required

MIT

README

Martin Helmich [e-mail]

Synopsis

This repository contains an example application that demonstrates on how to implement RESTful Webservices with TYPO3 Flow. It contains three packages:

• Helmich.Products contains entity classes and repositories around a simple inventory management domain model
• Helmich.ProductsApiSimple contains a simple REST-like API (level 2 of the Richardson Maturity Model) which allows you to CRUD products and manufacturers using respective HTTP methods.
• Helmich.ProductsApiAdvanced contains an advanced API (level 3 of the RMM), which is hypermedia controlled (which means that there are links between resources) and also shows some design patterns to decouple your REST resource representations from your domain entities.

Installation

You can install this application using Composer:

composer create-project helmich/flow-restapi-example

Follow the TYPO3 Flow installation instructions in all other ways. Also set up your database and run the database migrations:

./flow doctrine:migrate