Le 14 septembre 2017, nous avons publié une version actualisée de notre Politique de confidentialité. En utilisant video2brain.com vous vous engagez à respecter ces documents mis à jour. Veuillez donc prendre quelques minutes pour les consulter.

Découvrir API Platform

Ajouter des annotations

TESTEZ LINKEDIN LEARNING GRATUITEMENT ET SANS ENGAGEMENT

Tester maintenant Afficher tous les abonnements
Ajoutez des annotations pour rendre les entités disponibles dans API Platform. La mise en place sera automatique, ainsi que la création de la documentation.
03:14

Transcription

Créer une entité, c’est bien mais ce n’est pas suffisant, pourquoi ? Parce qu’il faut obligatoirement donner l’information à API Platform que cette entité va être utilisée en tant qu’entité API Platform parce que vous pourriez en avoir d’autres qui ne sont pas utilisés dans API Platform. Alors si vous prenez la page de documentation qui se trouve ici, en fait ce sont les documentations de base donc sur l’installation, on a une section qui s’appelle : « Mapping the Entities ». « Mapping the Entities » vous permet donc de vous remémorer ce qu’on vient de faire ensemble. Simplement donc, vous allez créer une entité mais surtout si vous regardez bien la différence entre la description ici de la classe de l’entité et notre description à nous actuellement, vous remarquerez qu’il y a quelque chose de différent. Et qu’est-ce qu’il y a de différent ? Tout simplement ici, on a une annotation qui est extrêmement importante et qui s’appelle « Resource » et cette annotation-là, elle va utiliser ici un « namespace » qui est un « namespace » API Platform, qui est donc sur : le « Core\Annotation\ApiResource ». Alors, on va devoir rajouter ces deux informations pour que notre entité soit prise en compte dans API Platform. C’est extrêmement important si vous voulez que votre entité soit automatiquement récupérée et disponible dans votre API. On va simplement rajouter ces deux informations : l’annotation « @ApiResource » qui définit que « Task » va être une ressource API et ici le « namespace ». Alors ne vous inquiétez pas pour les « namespaces » si comme ça ils apparaissent en gris, c’est tout à fait normal, c’est parce que PhpStorm a un petit peu de mal en fait à relier les deux et à vous dire qu’effectivement vous êtes bien en train de l’utiliser. En faisant ça, vous avez référencé automatiquement, il n’y a pas besoin de faire plus, vous avez référencé une entité comme étant disponible dans API Platform. Comment ça marche derrière ? Qu’est-ce qui va faire que ça va être récupéré ? Tout simplement, c’est la compilation ensuite de votre API Platform et c’est le fait qu’on puisse avoir ici une annotation qui fait qu’elle se référence en tant que telle. Il faut savoir aussi que si vous regardez le fichier de « routing » dans « app/config/routing.yml », vous allez voir qu’ici effectivement, tout ce qui va être en annotation va être récupéré automatiquement par API Platform. Alors ensuite dans la doc on vous donne un petit peu plus d’information. On vous donne ici tous les verbes que vous allez pouvoir utiliser et comment vous allez pouvoir les utiliser et on vous montre aussi, pourquoi pas, comment référencer une entité comme étant disponible avec d’autres ressources possibles. Donc pas forcément les annotations mais pourquoi pas en « yml » et puis pourquoi pas en « xml ». Peut-être que vous préférez travailler dans ces formats-là pour la configuration de vos projets. C’est possible de le faire, ce n’est pas obligatoire. On vous conseille même d’ailleurs plutôt de partir sur les annotations mais sachez que c’est possible sans aucun problème. Dernière chose qu’on va faire là pour le référencement, on va retourner ici sur votre « host » directement et on va simplement demander à le voir. Donc vous allez démarrer votre API Platform et vous allez voir qu’effectivement votre API Platform et votre entité deviennent disponibles automatiquement. En ajoutant l’annotation, vous rendez l’entité disponible. Et du coup, c’est extrêmement simple à mettre en place. Vous créez votre entité et vous la référencez et c’est suffisant pour l’avoir de disponible et vous voyez que dans la documentation, ça s’est mis à jour également.

Découvrir API Platform

Prenez en main le framework API Platform. Voyez comment effectuer sa configuration, créer des services web de données, et réalisez ainsi efficacement une application complète.

3h24 (54 vidéos)
Aucun commentaire n´est disponible actuellement
 

Votre formation est disponible en ligne avec option de téléchargement. Bonne nouvelle : vous ne devez pas choisir entre les deux. Dès que vous achetez une formation, vous disposez des deux options de consultation !

Le téléchargement vous permet de consulter la formation hors ligne et offre une interface plus conviviale. Si vous travaillez sur différents ordinateurs ou que vous ne voulez pas regarder la formation en une seule fois, connectez-vous sur cette page pour consulter en ligne les vidéos de la formation. Nous vous souhaitons un excellent apprentissage avec cette formation vidéo.

N'hésitez pas à nous contacter si vous avez des questions !