leçon n°139, API Platform ce n'est que pour du POC, FAUX !

@gheb_dev Leçon n°139, API-Platform Ce n’est bon qu’à faire un
POC ! Faux !

@gheb_dev Grégoire Hébert ‣Senior Developper & Trainer @ Les-Tilleuls.coop ‣CEO
of MasterClass by Les-Tilleuls.coop @gheb_dev @gregoirehebert

@gheb_dev Self Managed since 2011 36 people, + 1000% in
6 years [email protected] 13 full courses & custom courses [email protected]

@gheb_dev R.A.D.

@gheb_dev

@gheb_dev R.A.D.

@gheb_dev Let’s see why it’s worth it!

@gheb_dev Richardson’s Maturity Chart Graphql I see you…

@gheb_dev LvL 0: Always the same URL in POST with
a 200 return status code. POST: /api

@gheb_dev Richardson’s Maturity Chart

@gheb_dev LvL 1: Each type of data has its own
URL. POST: /books POST: /customers

@gheb_dev LvL 2: We use speciﬁc verbs for speciﬁc actions
with status codes according to the result. GET: /books POST: /books PUT: /books/12

@gheb_dev LvL 3: Hateoas - Hypermedia As The Engine Of
Application State. We add links to describe how to get to the information in the answer. { "@context": { "comments": "http://api.example.com/vocab#comments" }, "@id": "http://api.example.com/an-issue", "title": "An exemplary issue linking to its comments", "comments": { "@id": "http://api.example.com/an-issue/comments" } }

@gheb_dev

@gheb_dev V1 - DunglasJsonLdApiBundle Mars 2015

@gheb_dev V1 - DunglasJsonLdApiBundle Mars 2015 Juin 2015 Dedicated Website

Septembre 2015 V2 Annonced

Septembre 2015 V2 Announced Mai 2016 V2 Alpha Available

@gheb_dev Septembre 2015 V2 Announced Mai 2016 V2 Alpha Available

January 2017 V2 Stable Available

January 2017 V2 Stable Available V2.2 February 2018

January 2017 V2 Stable Available February 2018 V2.2 March 2019 V2.4

January 2017 V2 Stable Available February 2018 V2.2 February 2019 V2.4

January 2017 V2 Stable Available February 2018 V2.2 March 2019 V2.4

@gheb_dev First ApiResource

@gheb_dev You’ve got the power

@gheb_dev Some attributes

@gheb_dev Any Public, Protected, Private property will be accessible through
your API   As long as you deﬁne the means to access it ! THANKS TO… ?

@gheb_dev Restricting the operations

@gheb_dev Diﬀerentiating the expected income and the outcome

@gheb_dev Source: https://symfony.com/doc/current/components/serializer.html

@gheb_dev Diﬀerentiating the expected income and the outcome

@gheb_dev ORM mapping

@gheb_dev

@gheb_dev R.A.D.

@gheb_dev Ok, but not everything is about CRUD or REST
!

@gheb_dev

@gheb_dev Activate Mercure for a resource

@gheb_dev

@gheb_dev source: Samuel Roze « Symfony Messenger: Messages, Queues, Workers
and More »

@gheb_dev Activate messenger for a resource

@gheb_dev Deﬁning a Handler

@gheb_dev

@gheb_dev Conﬁguring Messenger component

@gheb_dev

@gheb_dev Going Further

@gheb_dev

@gheb_dev Conﬁgure the workﬂow

@gheb_dev Deﬁning states constants

@gheb_dev Conﬁguration using constants

@gheb_dev How to get for any resource a way to
update the state ?

@gheb_dev Leverage the extensibility of   API Platform

@gheb_dev Decorating the ResourceMetadataFactory

@gheb_dev Inject the supported resources

@gheb_dev Decorating the OperationPathResolver

@gheb_dev Change the state on post deserialize

@gheb_dev I get a new operation to update the state

@gheb_dev Going Further (again)

@gheb_dev Let’s consider we have Holder resource  which is used
as a User, with a JWT Authentication

@gheb_dev Reverse side Linking a WaitingLine to a Holder

@gheb_dev What if I want to set/remove ownership right after
the change of state   with API Platform?

@gheb_dev YOU DON’T.

@gheb_dev Setting the ownership

@gheb_dev Don’t forget to leverage the power of the Symfony
components you use. They are highly tested !

@gheb_dev A little demo maybe?

@gheb_dev Going Further (again, again)  promised, this is the last
time

@gheb_dev Sometimes, you need to split up your code. Let’s
imagine a password request scenario

@gheb_dev

@gheb_dev Get a resource

@gheb_dev Create a resource

@gheb_dev

@gheb_dev Setting RabbitMQ as transporter

@gheb_dev Creating the resource

@gheb_dev Set messenger

@gheb_dev Deﬁne the operations

@gheb_dev Deﬁne the input and output

@gheb_dev Deﬁne the input class

@gheb_dev I can now reset my password

@gheb_dev Create a resource Output is set to false, nothing
to do We need to create the transformers

@gheb_dev Transform the post input into a ressource

@gheb_dev Maybe using the incoming AutoMapper there?

@gheb_dev Encode the new password on PUT request

@gheb_dev

@gheb_dev Create the Handler

@gheb_dev Handle the token creation

@gheb_dev Handle the password update and remove the token

@gheb_dev Add a custom constraint to check the expiration

@gheb_dev

@gheb_dev You’ve got a fully decoupled reset password procedure !

@gheb_dev Spice all this with your favorites Testing frameworks

@gheb_dev Plug-in your favorite CI / CD system

@gheb_dev And you’ve got a robust API For middle to
large applications

@gheb_dev THANK YOU ! I am so thirsty right now…
But if you’ve got any question :)

leçon n°139, API Platform ce n'est que pour du ...

leçon n°139, API Platform ce n'est que pour du POC, FAUX !

More Decks by Grégoire Hébert

Other Decks in Programming

Featured

Transcript