Upgrade to Pro — share decks privately, control downloads, hide ads and more …

FOSRestBundle, Symfony User Group Cologne

FOSRestBundle, Symfony User Group Cologne

B50a40d1c576ef0aa065cbc5d4d6dec9?s=128

Christian Flothmann

March 09, 2016
Tweet

Transcript

  1. basecom · wir sprechen internet 1 FOSRestBundle

  2. basecom · wir sprechen internet 2 Christian Flothmann Software-Entwickler bei

    basecom in Osnabrück - Symfony Core Team - Symfony Documentation Team - Co-Maintainer FOSRestBundle @xabbuh
  3. basecom · wir sprechen internet 3 Was ist REST?

  4. basecom · wir sprechen internet 4 1. Client-Server 2. Stateless

    3. Caching 4. Einheitliche Schnittstelle 5. Mehrschichtige Systeme 6. Code on Demand Roy Thomas Fielding (2000)
  5. basecom · wir sprechen internet 5 REST Maturity Model nach

    Leonard Richardson
  6. basecom · wir sprechen internet 6 • XML-RPC/SOAP • Eine

    URI • Eine HTTP-Methode Level 0
  7. basecom · wir sprechen internet 7 • Verschiedene URIs •

    Aber nur eine HTTP-Methode Level 1
  8. basecom · wir sprechen internet 8 • Verschiedene URIs •

    Mehrere HTTP-Methoden Level 2
  9. basecom · wir sprechen internet 9 • Verschiedene URIs •

    Mehrere HTTP-Methoden • Basiert auf HATEOAS (Hypermedia as the Engine of Application State) Level 3
  10. basecom · wir sprechen internet 10 • Routing: diverse HTTP-Methoden,

    viele Controller • Anfragen: kodierter Content (JSON, XML, etc.) • Content-Negotiation • Unterschiedliche Antwortformate je Client Herausforderungen
  11. basecom · wir sprechen internet 11 Routing

  12. basecom · wir sprechen internet 12 class PostController { public

    function getPostsAction() { } public function getPostAction($id) { } public function postPostAction() { } public function putPostAction($id) { } public function deletePostAction($id) { } } Routing
  13. basecom · wir sprechen internet 13 # app/config/routing.yml post_api: resource:

    "@AppBundle/Controller/PostController.php" type: rest Routing
  14. basecom · wir sprechen internet 14 $ php app/console debug:router

    ------------- -------- -------- ------ ----------------------- Name Method Scheme Host Path ------------- -------- -------- ------ ----------------------- get_posts GET ANY ANY /posts.{_format} get_post GET ANY ANY /posts/{id}.{_format} post_post POST ANY ANY /posts.{_format} put_post PUT ANY ANY /posts/{id}.{_format} delete_post DELETE ANY ANY /posts/{id}.{_format} ------------- -------- -------- ------ ----------------------- Routing
  15. basecom · wir sprechen internet 15 Routing mit Subressourcen

  16. basecom · wir sprechen internet 16 class PostController { //

    ... public function postPostCommentAction($postId) { } public function getPostCommentsAction($postId) { } public function getPostCommentAction($postId, $commentId) { } } Routing mit Subressourcen
  17. basecom · wir sprechen internet 17 $ php app/console debug:router

    ------------------- -------- -------- ------ ------------------------------------------------ Name Method Scheme Host Path ------------------- -------- -------- ------ ------------------------------------------------ get_posts GET ANY ANY /posts.{_format} get_post GET ANY ANY /posts/{id}.{_format} post_post POST ANY ANY /posts.{_format} put_post PUT ANY ANY /posts/{id}.{_format} delete_post DELETE ANY ANY /posts/{id}.{_format} post_post_comment POST ANY ANY /posts/{postId}/comments.{_format} get_post_comments GET ANY ANY /posts/{postId}/comments.{_format} get_post_comment GET ANY ANY /posts/{postId}/comments/{commentId}.{_format} ------------------- -------- -------- ------ ------------------------------------------------ Routing mit Subressourcen
  18. basecom · wir sprechen internet 18 • Annotationen für: •

    HTTP-Methoden •Path-Prefix •Query- und Request-Parameter •View-Konfiguration •Erlaubte Request-FormatePath-Prefix • Subressourcen in eigener Controller-Klasse Routing – Fine-Tuning
  19. basecom · wir sprechen internet 19 1. Body Listener 2.

    Format Listener 3. View Response Listener Listener
  20. basecom · wir sprechen internet 20 Listener 1. Body Listener

  21. basecom · wir sprechen internet 21 • Body der Anfragen

    mit unterschiedlichem Content Type •JSON •XML •etc. • Problem: Request nicht application/x-www-form-urlencode kodiert • Body Listener: Request Body dekodieren • optional: Array normalisieren • Request ParameterBag aktualisieren Listener – 1. Body Listener
  22. basecom · wir sprechen internet 22 Listener – 1. Body

    Listener # app/config/config.yml fos_rest: body_listener: throw_exception_on_unsupported_content_type: false decoders: json: fos_rest.decoder.json xml: fos_rest.decoder.xml array_normalizer: fos_rest.normalizer.camel_keys
  23. basecom · wir sprechen internet 23 Listener 2. Format Listener

  24. basecom · wir sprechen internet 24 • Aufgabe: Content-Type der

    Antwort bestimmen • Basierend auf Accept-Header des Clients • Prioritäten konfigurierbar Listener – 2. Format Listener
  25. basecom · wir sprechen internet 25 Listeners – 2. Format

    Listener # app/config/config.yml fos_rest: format_listener: enabled: true rules: - path: '^/' host: 'api.%domain%' priorities: ['json', 'xml'] fallback_format: json prefer_extension: false - path: '^/api' priorities: [ 'xml', 'json'] fallback_format: xml attributes: { _controller: FOS\RestBundle\Controller\ExceptionController } prefer_extension: false - path: '^/' priorities: [ 'text/html', '*/*'] fallback_format: html prefer_extension: true
  26. basecom · wir sprechen internet 26 Listeners 3. View Response

    Listener
  27. basecom · wir sprechen internet 27 • Keine Response in

    Controller • Stattdessen: Format-unabhängiges View-Object • Konvertierung von View zu Response in Event Listener Listeners – 3. View Response Listener
  28. basecom · wir sprechen internet 28 Listeners – 3. View

    Response Listener use FOS\RestBundle\View\View; class PostController { public function getPostAction($id) { $post = $this->findPost($id); if (null === $post) { $view = View::create(null, 404); } else { $view = View::create($post); } return $view; } }
  29. basecom · wir sprechen internet 29 Listeners – 3. View

    Response Listener alternativ: FOSRestController erweitern
  30. basecom · wir sprechen internet 30 Listeners – 3. View

    Response Listener use FOS\RestBundle\Controller\FOSRestController; class PostController extends FOSRestController { public function getPostAction($id) { // find the blog post by id $post = $this->findPost($id); if (null === $post) { $view = $this->view(null, 404); } else { $view = $this->view($post); } return $view; } }
  31. basecom · wir sprechen internet 31 FOSRestBundle 2.0

  32. basecom · wir sprechen internet 32 • COPY • LOCK

    • MKCOL • MOVE • PROPFIND • PROPPATCH • UNLOCK HTTP-Methoden nach RFC-2518
  33. basecom · wir sprechen internet 33 Routing aus Verzeichnis #

    app/config/routing.yml post_api: resource: "@AppBundle/Controller/Api/PostController.php" type: rest post_comment_api: resource: "@AppBundle/Controller/Api/PostCommentController.php" type: rest article_api: resource: "@AppBundle/Controller/Api/ArticleController.php" type: rest article_comment_api: resource: "@AppBundle/Controller/Api/ArticleCommentController.php" type: rest tag_api: resource: "@AppBundle/Controller/Api/TagController.php" type: rest
  34. basecom · wir sprechen internet 34 Routing aus Verzeichnis api:

    resource: "@AppBundle/Controller/Api" type: rest
  35. basecom · wir sprechen internet 35 Routing aus Verzeichnis

  36. basecom · wir sprechen internet 36 Routing aus Verzeichnis

  37. basecom · wir sprechen internet 37 Routing aus Verzeichnis api:

    resource: "%kernel.root_dir%/../src/AppBundle/Controller/Api" type: rest Achtung: Funktioniert leider auch nicht!
  38. basecom · wir sprechen internet 38 Routing aus Verzeichnis

  39. basecom · wir sprechen internet 39 Routing aus Verzeichnis

  40. basecom · wir sprechen internet 40 • View-Handling ohne Symfony

    Basis-Controller • Shortcut-Methoden zum Handling von Views: view() redirectView()/routeRedirectView() handleView() setViewHandler()/getViewHandler() Controller Trait
  41. basecom · wir sprechen internet 41 Controller Trait use FOS\RestBundle\Controller\FOSRestController;

    class PostController extends FOSRestController { public function getPostAction($id) { // find the blog post by id $post = $this->findPost($id); if (null === $post) { $view = $this->view(null, 404); } else { $view = $this->view($post); } return $view; } }
  42. basecom · wir sprechen internet 42 Controller Trait use FOS\RestBundle\Controller\ControllerTrait;

    class PostController { use ControllerTrait; public function getPostAction($id) { // find the blog post by id $post = $this->findPost($id); if (null === $post) { $view = $this->view(null, 404); } else { $view = $this->view($post); } return $view; } }
  43. basecom · wir sprechen internet 43 • Abstraktionslayer • Adapter

    für Symfony Serializer JMS Serializer • Extension-Point für eigene Adapter • Type-Hinting möglich Serializer-Layer
  44. basecom · wir sprechen internet 44 Serializer-Layer namespace FOS\RestBundle\Serializer; use

    FOS\RestBundle\Context\Context; interface Serializer { /** * @param mixed $data * @param string $format * @param Context $context * * @return string */ public function serialize($data, $format, Context $context); // ... }
  45. basecom · wir sprechen internet 45 Serializer-Layer namespace FOS\RestBundle\Serializer; use

    FOS\RestBundle\Context\Context; interface Serializer { // ... /** * @param string $data * @param string $type * @param string $format * @param Context $context * * @return mixed */ public function deserialize($data, $type, $format, Context $context); }
  46. basecom · wir sprechen internet 46 • Unterschiedliche Strategien: URI-Parameter

    (/v1/users) Query-Parameter (/users?version=v1) Mime-Type-Header (Accept: application/json; version=1.0) Eigener Header (X-Accept-Version: v1) • Wahl aktivierter Strategien • Strategien priorisierbar • Aktuelle Version als Attribut des Requests verfügbar Versionierung
  47. basecom · wir sprechen internet 47 Versionierung # app/config/config.yml fos_rest:

    versioning: enabled: true resolvers: query: true custom_header: enabled: true header_name: X-Accept-Version media_type: enabled: true regex: '/(v|version)=(?P<version>[0-9\.]+)/' guessing_order: - query - custom_header - media_type
  48. basecom · wir sprechen internet 48 • FOSRest-Listener bei jedem

    Request aktiv • Verbrauchen Ressourcen • ggfl. Konflikt mit anderen Listenern REST-Zonen
  49. basecom · wir sprechen internet 49 • Trennung von API

    und „normaler“ Anwendung • Definition von „REST-Zonen“ anhand von Request-Attributen URI-Pfad Host HTTP-Methode IP-Adressen REST-Zonen
  50. basecom · wir sprechen internet 50 REST-Zonen # app/config/config.yml fos_rest:

    zone: - path: '^/api' - path: '/test' ips: ['127.0.0.1'] - path: '/api-test' host: 'api-test.example.com'
  51. basecom · wir sprechen internet 51 Release?

  52. basecom · wir sprechen internet 52

  53. basecom · wir sprechen internet 53 { "require": { "friendsofsymfony/rest-bundle":

    "~2.0@beta" } }
  54. basecom · wir sprechen internet 54 Upgraden?

  55. basecom · wir sprechen internet 55 • 2.0 nicht vollständig

    abwärtskompatibel • Vorbild: Symfony 2.8/3.0 • 1.8 Release zeitgleich mit 2.0 • abwärtskompatible Features in 1.8 • Deprecation-Trigger für BC-Breaks Upgrade-Pfad
  56. basecom · wir sprechen internet 56 Vielen Dank für die

    Aufmerksamkeit!