Nous mettrons à jour notre Politique de confidentialité prochainement. En voici un aperçu.

Découvrir API Platform

Générer la documentation du projet

Testez gratuitement nos 1343 formations

pendant 10 jours !

Tester maintenant Afficher tous les abonnements
La création de la documentation de base d'API Platform n'étant pas configurable, vous utiliserez le bundle NelmioAPIDoc. Ainsi, vous produirez une documentation bien plus intéressante.
04:02

Transcription

En termes de documentation, il y a deux concurrents très forts. Le premier, forcément, vous le connaissez puisqu'on l'utilise depuis le début, c'est la « Doc » qui est auto-générée par « API Platform ». C'est au moins, ce n'est pas quand même la meilleure des « Docs » parce qu'on n'a pas toutes les possibilités d'une vraie documentation « API ». Ça veut dire quoi, une vraie documentation « API » ? Voilà, je vous parle du concurrent direct « NelmioApiDocBundle » qui est le « bundle » pour créer des « API », qui existe depuis très longtemps maintenant et qui va prendre en compte, en plus, dans les nouvelles versions depuis la 2.9, « Api Platform ». Si vous avez envie d'utiliser ce « Bundle-là », il va falloir l'installer et je vais vous montrer comment faire. La première chose à faire, c'est qu'on va activer le support « API Platform » et pour ce faire, on va aller dans « app », on va aller dans « config », on va aller dans « config.yml » et ici, on va ajouter le paramètre, du coup, « enable nelmio api doc », mais attention, ce n'est pas tout. Maintenant, il faut qu'on installe « nelmio api doc ». Voilà la commande que vous allez devoir taper ; « composer required nelmio/ api-doc-bundle ». Vous allez lancer cette commande qui va mettre un petit temps à charger et puis, une fois qu'elle aura terminé, vous allez avoir sur votre « Symfony », ce nouveau composant, ce nouveau « bundle » d'installé et il sera disponible, donc, vous pourrez l'utiliser pour générer la « Doc ». Alors, attention, il y a maintenant un petit peu de configuration. On va devoir se rendre sur la documentation du « NelmioApiDocBundle », on va descendre un tout petit peu, on va aller lire la documentation, on va surtout suivre les étapes. On vous dit évidemment qu'il faut l'installer. Ça, c'est fait, ici, c'est installé, ça va, en tout cas, prendre du temps, mais c'est installé. On vous dit ensuite qu'il va falloir ici, ajouter le nouveau « Bundle » à votre « Kernel ». Donc ça, on va le faire à la main. Là, voilà, ça, c'est terminé, pensez bien que cette partie-là soit terminée avant d'enchaîner le reste. On va donc, ici, dans le « Kernel » donc le « AppKernel» qui se trouve là, on va définir ce nouveau « bundle ». Ensuite, on vous dit qu'il faut enregistrer les routes. On va prendre toute cette partie de « routing », ici, et on va aller dans notre « routing » principale ; « app, config, routing.yml » et on va définir ces routes-là, en tout premier, « api/doc » pour accéder à la documentation de « Nelmio ». En fin, vous allez enregistrer de la « config » donc la configuration, c'est une « config » assez classique, certes qu'on ne la configure pas particulièrement, on va simplement lui dire ; « prends la configuration par défaut en utilisant le fameux tilde qu'on a là ». Alors, il y aura plein de configurations possibles, certes que c'est une documentation qui est complètement paramétrable, on peut faire énormément de choses avec, ça va carrément lire les annotations de nos différents schémas pour sortir de la « Doc », etc. C'est très puissant comme « Doc », je trouve ça vraiment génial. Une fois que vous avez fait ça, vous allez simplement recharger votre projet. Alors, ça ne va pas changer grand chose, vous aurez toujours accès, ici, à cette documentation auto-générée, mais surtout maintenant, vous allez pouvoir accéder à « api/doc » qui vous permettra d'avoir la documentation générée, directement, par le « NelmioDocBundle ». Voilà, vous avez maintenant, deux documentations différentes qui vous permettent de générer la documentation. Et sur celle-ci, vous allez avoir beaucoup de possibilité différentes puisque vous irez regarder la configuration, il y a une configuration qui est très épaisse et qui vous permet de faire énormément de choses donc il y a beaucoup de configurations possibles. Pour voir les différentes « Docs » d'utilisation, il faudra aller sur le petit lien ici de « doc » et là, vous aurez, ici, tous les fichiers à rester d'explication qui vous expliqueront vraiment comment configurer proprement, notamment, ce petit chapitre la Configuration « in-Depth » donc configuration, vraiment, en allant au plus loin possible. Vous aurez là, toutes les authentifications possibles et section, ce qu'on peut faire, les « Parsers » qu'on peut mettre en place, le « MOTD », c'est pour rajouter une première bannière pour votre entreprise, par exemple, est-ce qu'on active le « cache » ou pas. Il y a vraiment beaucoup de « configs » possibles, n'hésitez pas à lire cette partie-là parce qu'elle est vraiment importante et ça va vous permettre de configurer, proprement, la générations de votre « Doc » et de faire exactement ce que vous voulez.

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 !