Show Menu
Cheatography

Api Platform Cheat Sheet by

Tout ce qu'il faut savoir sur Api Platform

API Restful

Crée en 2000
Roy Fielding (cofon­dateur d'Apache)
Basé sur le protocole HTTP
Requete GET (récupérer une entité), POST (créé une entité), PUT (mettre a jour tous les champs d'une entité), PATCH (mettre à jour un seul champ d'une entité), DELETE (supprime une entité)
Plusieur format de commun­ication
JSON, XML, CSV, RSS...
 

Protocol HTTP

Envoi de la requete avec le type et l'url d'API
Envoi de l'header
Header qui contient le body de notre requete
Réponse HTTP
Body avec le code de la réponse

Différent codes HTTP

2XX : Code de succès
3XX : Code de redire­ction
4XX : Code de faute de la part du client
5XX : Code de faute de la part du serveur

200 : Ok
201 : Created
204 : No content

301 : Moved Perman­ently
307 : Temproary Redirect

400 : Bad Request
401 : Unauth­orized
404 : Not found
405 : Method Not Allowed

500 : Internal Server Error
 

Api Platform

DataFi­xtures : Permets de crée de fausse instances de nos entités en base de données.
Faker déprécié => Utilise Faker/­Factory altern­ative a Faker

Entité : normal­oza­tio­nCo­ntext permet d'auto­riser la lecture et le denorm­ali­zat­ion­Context permet d'auto­riser l'écriture et la modifi­cation de l'élément.
Sur chaque entité l'on peut rajouter des groups en rapport avec la normal­iza­tio­nnC­ontext et denorm­ali­zat­ion­Context pour autoriser la lecture et modifi­cation.
On peut aussi spécifier la longueur de notre champs avec un min, max et un message en cas d'erreur. De meme pour le type ainsi qu'en cas de champs vide.
Au début de chaque entité, on peut stipulé aussi les autori­sation quand au requête HTTP que l'on peut envoyé, c'est à dire qui peut le faire, avec une descri­ption de la requette mais aussi la sécurité (is_gr­anted).

EventS­ubs­criber : Permet d'envoyer une action sur un évènement désiré (création d'entité, GET, POST…)

OpenAPI : JwtDec­orator, permet de créé un jeton d'auth­ent­ifi­cation pour Api-Pl­atform. Modifier le fichier securi­ty.yaml avec les attributs firewalls. Un fichier lexik_­jwt­_au­the­nti­fic­ati­on.yaml est crée dans le config­/pa­ckages.

Voter : Permet d'attr­ibuer des autori­sation en fonction du niveau de l'util­isa­teur.
           
 

Comments

No comments yet. Add yours below!

Add a Comment

Your Comment

Please enter your name.

    Please enter your email address

      Please enter your Comment.

          Related Cheat Sheets

          CSS2 Cheat Sheet
          PHP Cheat Sheet
          JavaScript Cheat Sheet