Designing REST API with Silex

Description

Silex is a brand new PHP 5.3 micro framework built on top of the Symfony2 de decoupled components. In this session, we will discover how to build and deploy powerful REST web services with such a micro framework and its embedded tools.

The first part of this talk will introduce the basics of the REST architecture. We fill focus on the main concepts of REST like HTTP methods, URIs and open formats like XML and JSON.

Then, we will discover how to deploy REST services using most of interesting Silex tools like database abstraction layer, template engine and input validation. We will also look at unit and functional testing frameworks with PHPUnit and HTTP caching with Edge Side Includes and Varnish support to improve performances.

Transcript

2. @hhamon
3. Designing REST APIs with Silex
4. What is Silex?
8. http://silex.sensiolabs.org
9. Why choosing Silex?
10. What’s inside?
11. The Silex Philosophy
12. vendor/ web/
13. Silex Mantra namespace Symfony\Component\HttpKernel; interface HttpKernelInterface { (Response) function handle(Request $request); }
14. Request Handling require_once __DIR__.'/../vendor/autoload.php'; $app = new Silex\Application(); $app->get('/hello/{name}', function($name) use($app) { return 'Hello '. $app->escape($name); }); $app->run();
15. Request Handling require_once __DIR__.'/../vendor/autoload.php'; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; $app = new Silex\Application(); $app->get('/hello/{name}', function(Request $request) use($app) { $name = $request->attributes->get('name'); return new Response('Hello '. $app->escape($name)); });
16. $app == DIC
17. Deploying REST Web services
18. REpresentational State Transfer
19. Architecture style
20. Designing REST APIs
21. $app->get('/events', function (Request $request) { $events = array( array('name' => 'OSIDays', 'venue' => 'Bangalore'), array('name' => 'PHP Tour', 'venue' => 'Lille'), array('name' => 'Confoo', 'venue' => 'Montreal'), // ... ); return new Response(json_encode($events), 200, array( 'Content-Type' => 'application/json' )); });
22. $app->post('/event', function (Request $request) use ($app) { // Get POST data or 400 HTTP response if (!$data = $request->get('event')) { return new Response('Missing parameters.', 400); } // Persist data to the database $event = new Event() $event->title = $data['title']; $event->venue = $data['venue']; $event->save(); // Trigger redirect to the newly created record URI return $app->redirect('/event/'. $event->id, 201); });
23. $app->put('/event/{id}', function ($id) use ($app) { if (!$data = $request->get('event')) { return new Response('Missing parameters.', 400); } if (!$event = $app['event_manager']->find($id)) { return new Response('Event not found.', 404); } $event->title = $data['title']; $event->venue = $data['venue']; $event->save(); return new Response('Event updated.', 200); });
24. $app->delete('/event/{id}', function ($id) use ($app) { $event = $app['event_manager']->find($id); if (!$event) { return new Response('Event not found.', 404); } $event->delete(); return new Response('Event deleted.', 200); });
25. Advanced routing
26. $app->get('/archive/{year}/{month}', function ($month, $year) { // ... }) ->bind('archives') // Route name ->value('year', date('Y')) // Default parameter value ->value('month', date('m')) ->assert('year', '\d{4}') // Parameter format ->assert('month', '\d{2}');
27. Events management
28. $app->before(function (Request $request) use ($app) { $user = $request->server->get('PHP_AUTH_USER'); $pwd = $request->server->get('PHP_AUTH_PW'); if ($app['api_user'] !== $user || $app['api_pwd'] !== $pwd) { return new Response('Unauthorized', 403); } });
29. $app->after(function (Request $request, Response $response) { // Get URI parameter to determine requested output format $format = $request->attributes->get('format'); switch ($format) { case 'xml': $response->headers->set('Content-Type', 'text/xml'); break; case 'json': $response->headers->set('Content-Type', 'text/json'); break; default: $response->headers->set('Content-Type', 'text/plain'); break; } });
30. Exception and error handling
31. $app->error(function (\Exception $e, $code) { switch ($code) { case 400: $message = 'Bad request.'; break; case 404: $message = 'Page not found.'; break; default: $message = 'Internal Server Error.'; } return new Response($message, $code); });
32. $app['debug'] = true;
33. $app->post('/event', function (Request $request) use ($app) { if (!$event = $request->get('event')) { $app->abort(400, 'Missing parameters.'); } // ... return $app->redirect('/event/'. $event->id, 201); });
34. Logging with Monolog
35. use Silex\Provider\MonologServiceProvider; $app->register(new MonologServiceProvider(), array( 'monolog.logfile' => __DIR__.'/../logs/app.log', 'monolog.class_path' => __DIR__.'/../vendor/monolog/src', ));
36. if ($app['debug']) { $app['monolog']->addInfo('Testing the Monolog logging.'); $app['monolog']->addDebug('Method foo() was called.'); $app['monolog']->addWarning('Missing parameter "bar".'); $app['monolog']->addError('Class Foo does not exist.'); }
37. Database interactions with Doctrine
38. use Silex\Provider\DoctrineServiceProvider; $app->register(new DoctrineServiceProvider(), array( 'db.options' => array( 'driver' => 'pdo_mysql', 'host' => 'localhost', 'user' => 'root', 'dbname' => 'event_demo', ), 'db.dbal.class_path' => __DIR__.'/../vendor/doctrine-dbal/lib', 'db.common.class_path' => __DIR__.'/../vendor/doctrine-common/lib', ));
39. $app->get('/events', function () use ($app) { $query = 'SELECT id, title, venue FROM events'; $events = $app['db']->fetchAll($query); return new Response(json_encode($events)); });
40. Input validation
41. use Silex\Provider\ValidatorServiceProvider; $app->register(new ValidatorServiceProvider());
42. $app['validator']->validate($object);
43. namespace Confeet\Model; use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints\NotBlank; use Symfony\Component\Validator\Constraints\MaxLength; class Event extends Model { private $title; private $venue; static public function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('title', new NotBlank()); $metadata->addPropertyConstraint('title', new MaxLength(array('limit' => 50))); $metadata->addPropertyConstraint('venue', new NotBlank()); } }
44. $app->post('/event', function (Request $request) use ($app) { if (!$data = $request->get('event')) { $app->abort(400, 'Missing parameters.'); } $event = new Event() $event->setTitle($data['title']); $event->setVenue($data['venue']); if (count($app['validator']->validate($event)) > 0) { $app->abort(400, 'Invalid parameters.'); } $event->save(); return $app->redirect('/event/'. $event->id, 201); });
45. Template engine
46. § Fast § Concise and rich syntax § Automatic output escaping § Modern features § Extensible Twig
47. use Silex\Provider\TwigServiceProvider; $app->register(new TwigServiceProvider(), array( 'twig.path' => __DIR__.'/../views', 'twig.class_path' => __DIR__.'/../vendor/twig/lib', ));
48. $app->get('/events.{format}', function ($format) use ($app) { $events = array( array('name' => 'OSIDays', 'venue' => 'Bangalore'), array('name' => 'PHP Tour', 'venue' => 'Lille'), array('name' => 'Confoo', 'venue' => 'Montreal'), // ... ); return $app['twig']->render('events.'.$format.'.twig', array( 'events' => $events, )); }) ->assert('format', 'xml|json');
49. <!-- views/events.xml.twig --> <?xml version="1.0" encoding="utf-8" ?> <events> {% for event in events %} <event> <title>{{ event.title }}</title> <venue>{{ event.venue }}</venue> <begin>{{ event.startAt }}</begin> <end>{{ event.endAt }}</end> </event> {% endfor %} <events>
50. HTTP Caching & ESI
51. Reverse Proxy Caching
52. use Silex\Provider\HttpCacheServiceProvider; $app->register(new HttpCacheServiceProvider(), array( 'http_cache.cache_dir' => __DIR__.'/../cache', ));
53. $app->get('/events', function () use ($app) { $events = array( array('name' => 'OSIDays', 'venue' => 'Bangalore'), // ... ); $content = $app['twig']->render('events.twig', array( 'events' => $events, )); return new Response($content, 200, array( 'Cache-Control' => 'public, s-maxage=3600', 'Surrogate-Control' => 'content="ESI/1.0"', )); });
54. Edge Side Includes
55. <!-- views/events.twig --> <?xml version="1.0" encoding="utf-8" ?> <events> <esi:include src="/metadata" /> <!-- ... --> <events>
56. $app->get('/metadata', function () use ($app) { return new Response('<meta>...</meta>', 200, array( 'Cache-Control' => 'public, s-maxage=600', )); });
57. Functional testing
58. Client Crawler PHPUnit
59. class EventApiTest extends Silex\WebTestCase { public function testRecentEvents() { $client = $this->createClient(); $crawler = $client->request('GET', '/events.xml'); $response = $client->getResponse(); $this->assertTrue($response->isOk()); $this->assertEquals(5, count($crawler->filter('event'))); $this->assertRegExp('/OSIDays/', $response->getContent()); ... } }
60. 92-98, boulevard Victor Hugo 92 115 Clichy Cedex, France trainings@sensio.com (+33 (0)140 998 211) sensiolabs.com - symfony.com – trainings.sensiolabs.com Ques%ons?