psx / psx-bundle
PSX Bundle
Installs: 28
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Type:symfony-bundle
Requires
- psx/psx: ~1.1
- symfony/framework-bundle: ~2.2
This package is auto-updated.
Last update: 2024-10-31 00:24:44 UTC
README
This Bundle provides basic PSX functionalities to Symfony. PSX is a framework
to build RESTful APIs. The bundle contains two annotations Incoming
and
Outgoing
which give the option to specify a JSONSchema for the incoming or
outgoing data. PSX formats the request and response according to the provided
schema. The bundle registers a kernel.controller
and kernel.response
listener to handle the validation and transformation. More information about PSX
at http://phpsx.org.
Usage
In the following a sample controller to showcase the usage. You have to use the
DataResponse
object in your controller methods so that PSX can transform the
data. If no outgoing schema was defined all data passthru.
<?php namespace AppBundle\Controller; use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route; use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method; use Symfony\Bundle\FrameworkBundle\Controller\Controller; use Symfony\Component\HttpFoundation\Request; use PSX\PSXBundle\Configuration\Incoming; use PSX\PSXBundle\Configuration\Outgoing; use PSX\PSXBundle\DataResponse; class DefaultController extends Controller { /** * @Method({"GET"}) * @Route("/", name="index") * @Outgoing("schema/incoming.json") */ public function indexAction(Request $request) { return new DataResponse([ 'firstName' => 'bar', 'lastName' => 'bar' ]); } /** * @Method({"POST"}) * @Route("/", name="new") * @Incoming("schema/outgoing.json") */ public function newAction(Request $request) { $data = $request->attributes->get(Context::REQUEST_BODY); // @TODO work with the parsed data // $data->getFirstName(); return new DataResponse([ 'success' => true, 'message' => 'Success!' ]); } }
Using the following JSON schema at app/schema/incoming.json
and
app/schema/outgoing.json
{ "title": "foo", "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "age": { "description": "Age in years", "type": "integer", "minimum": 0 } }, "required": ["firstName", "lastName"] }