Enable highend SPAs using REST-APIs with Symfony 4

Slide 1

Slide 1 text

ENABLE HIGHEND SINGLE PAGE APPLICATIONS USING REST-APIS  WITH SYMFONY 4 & FLEX

Slide 2

Slide 2 text

DENIS BRUMANN [email protected] @dbrumann

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

$kernel = new Kernel($env, $debug); $request = Request::createFromGlobals(); $response = $kernel->handle($request); $response->send();

Slide 5

Slide 5 text

Request Response call controller

Slide 6

Slide 6 text

/** * @Route("/", name="catalog") */ public function showAction(): Response { $products = $this->getDoctrine()  ->getRepository(Product::class)  ->findAll(); return $this->render( 'catalog/show.html.twig', [ 'products' => $products, ] ); }

Slide 7

Slide 7 text

Slide 8

Slide 8 text

/** * @Route("/products", name="products") * @Method("GET") */ public function listProducts() { return $this->getDoctrine()  ->getRepository(Product::class)  ->findAll(); }

Slide 9

Slide 9 text

/** * @Route("/products", name="products") * @Method("GET") */ public function listProducts() { return $this->getDoctrine()  ->getRepository(Product::class)  ->findAll(); } !❗

Slide 10

Slide 10 text

No content

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

No content

Slide 13

Slide 13 text

Request Response call controller kernel.  view

Slide 14

Slide 14 text

interface EventSubscriberInterface { public static function getSubscribedEvents(); }

Slide 15

Slide 15 text

public static function getSubscribedEvents() { return [ 'kernel.view' => 'onKernelView', ]; }

Slide 16

Slide 16 text

public function onKernelView(  GetResponseForControllerResultEvent $event  ) { $products = $event->getControllerResult(); $response = new JsonResponse($products); $event->setResponse($response); }

Slide 17

Slide 17 text

class JsonResponseHandler implements EventSubscriberInterface { public static function getSubscribedEvents() { return [ KernelEvents::VIEW => 'onKernelView', ]; } public function onKernelView(  GetResponseForControllerResultEvent $event  ) { $data = $event->getControllerResult(); $response = new JsonResponse($data); if ($data === null) { $response->setStatusCode(  JsonResponse::HTTP_NO_CONTENT  ); } $event->setResponse($response); } }

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

/** * @Route("/products/{id}", name="product_show") * @Method("GET") */ public function getProduct(int $id) { $product = $this->getDoctrine() ->getRepository(Product::class) ->find($id); if (!$product) { throw new NotFoundHttpException('...'); } return $product; }

Slide 20

Slide 20 text

No content

Slide 21

Slide 21 text

Request Response call controller kernel.  exception Exception

Slide 22

Slide 22 text

public static function getSubscribedEvents() { return [ 'kernel.exception' => 'myMethod', ]; }

Slide 23

Slide 23 text

$request = $event->getRequest(); if (strpos($request->getPathInfo(), '/api/') !== 0) { return; } $exception = $event->getException(); $error = [ 'type' => $this->detectErrorType($exception), // Warning! Passing the message is insecure! 'message' => $exception->getMessage(), ]; $response = new JsonResponse(  $error,  $this->detectStatusCode($exception)  ); $event->setResponse($response);

Slide 24

Slide 24 text

No content

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

No content

Slide 27

Slide 27 text

/** * @Route("/products", name="products_create") * @Method("POST") */ public function createProduct(Product $product) { $manager = $this->getDoctrine()->getManager(); $manager->persist($product); $manager->flush(); return new JsonResponse( null, JsonResponse::HTTP_CREATED ); }

Slide 28

Slide 28 text

curl -i http://localhost:8000/api/products -X "POST" -H "Content-Type: application/json" -d '{"name": "Mystery Box", "price": 3999}'

Slide 29

Slide 29 text

Request Response call controller kernel.  view kernel.  exception Exception resolve arguments

Slide 30

Slide 30 text

interface ArgumentValueResolverInterface { /** * Whether this resolver can resolve the value for the given  * ArgumentMetadata. * * @param Request $request * @param ArgumentMetadata $argument * * @return bool */ public function supports(Request $request, ArgumentMetadata $argument); /** * Returns the possible value(s). * * @param Request $request * @param ArgumentMetadata $argument * * @return \Generator */ public function resolve(Request $request, ArgumentMetadata $argument); }

Slide 31

Slide 31 text

public function supports(  Request $request,  ArgumentMetadata $argument  ) { return ( strpos($request->getPathInfo(), '/api/') === 0 && $argument->getType() === Product:class && !empty($request->getContent()) ); }

Slide 32

Slide 32 text

public function resolve(Request $request, ArgumentMetadata $argument) { $data = $this->serializer->deserialize( $request->getContent(), $argument->getType(), 'json' ); $errors = $this->validator->validate($data, null, $groups); if (count($errors)) { throw new BadRequestHttpException((string) $errors); } yield $data; }

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

Request Response kernel.  request kernel.  response kernel.  controller kernel.  exception resolve controller call controller kernel.  terminate Exception resolve arguments kernel.  view SYMFONY KERNEL EVENTS

Slide 35

Slide 35 text

No content

Slide 36

Slide 36 text

SYMFONY 4 BENEFITS No changes to services.yaml were needed! Only 1 added dependency (orm-pack) Small build artefact due to fewer dependencies

Slide 37

Slide 37 text

No content

Slide 38

Slide 38 text

PRODUCTION SETUP WITH  API-PLATFORM

Slide 39

Slide 39 text

No content

Slide 40

Slide 40 text

COMPOSER REQUIRE API

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

Slide 43

Slide 43 text

Slide 44

Slide 44 text

No content

Slide 45

Slide 45 text

No content

Slide 46

Slide 46 text

FEATURES Builds a fully featured API with JSON-LD, Hydra & GraphQL Auto-generated documentation with Swagger or Open API Authentication with JWT or OAuth HTTP Caching, CORS-support, schema.org-data model