« Programmation PHP avec Symfony/API » : différence entre les versions

=== FOS REST ===

FOSRestBundle apporte des annotations pour créer des contrôleurs d'API<ref>https://github.com/FriendsOfSymfony/FOSRestBundle</ref>. Installation :

composer require "friendsofsymfony/rest-bundle"

 

Puis dans <u>config/packages/fos_rest.yaml</u> :

fos_rest:

view:

- { path: '^/', prefer_extension: true, fallback_format: ~, priorities: [ 'html', '*/*'] }

- { path: ^/api, prefer_extension: true, fallback_format: json, priorities: [ json ] }

 

=== Doc ===

Toute API doit exposer sa documentation avec ses routes et leurs paramètres. NelmioApiDocBundle est un de générateur de documentation automatique à partir du code<ref>https://github.com/nelmio/NelmioApiDocBundle</ref>, qui permet en plus de tester en ligne. En effet, pour éviter de tester les API en copiant-collant leurs chemins dans une commande {{w|cURL}} ou dans des logiciels plus complets comme Postman<ref>https://www.postman.com/</ref>, on peut installer une interface graphique ergonomique qui allie documentation et test en ligne :

composer require "nelmio/api-doc-bundle"

 

Son URL se configure ensuite dans <u>routes/nelmio_api_doc.yml</u> :

app.swagger_ui:

path: /api/doc

methods: GET

defaults: { _controller: nelmio_api_doc.controller.swagger_ui }

 

A ce stade l'URL /api/doc affiche juste un lien ''NelmioApiDocBundle''.

 

==== symfony/serializer ====

composer require "symfony/serializer"

 

==== jms/serializer-bundle ====

composer require "jms/serializer-bundle"

 

== Utilisation ==

Maintenant /api/doc affiche les méthodes des différents contrôleurs API. Voici un exemple :

 

<?php

 

}

}

 

Maintenant dans /api/doc, cliquer sur /api/test, puis "Ty it out" pour exécuter la méthode de test.