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

Un livre de Wikilivres.
Contenu supprimé Contenu ajouté
Aucun résumé des modifications
Ligne 20 : Ligne 20 :
defaults: { _controller: nelmio_api_doc.controller.swagger_ui }
defaults: { _controller: nelmio_api_doc.controller.swagger_ui }
</source>
</source>

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


=== Sérialiseur ===
=== Sérialiseur ===
Enfin pour la sérialisation, on distingue plusieurs solutions :
Enfin pour la {{wt|sérialisation}}, on distingue plusieurs solutions :
* symfony/serializer, qui donne des contrôleurs <code>extends FOSRestController</code> et des méthodes aux annotations <code>@Rest\Post()</code><ref>https://www.thinktocode.com/2018/03/26/symfony-4-rest-api-part-1-fosrestbundle/</ref>.
* symfony/serializer, qui donne des contrôleurs <code>extends FOSRestController</code> et des méthodes aux annotations <code>@Rest\Post()</code><ref>https://www.thinktocode.com/2018/03/26/symfony-4-rest-api-part-1-fosrestbundle/</ref>.
* jms/serializer-bundle, avec des contrôleurs <code>extends RestController</code> et des méthodes aux annotations <code>@ApiDoc()</code>.
* jms/serializer-bundle, avec des contrôleurs <code>extends RestController</code> et des méthodes aux annotations <code>@ApiDoc()</code>.

Version du 31 mars 2019 à 11:10

Installation

Pour créer une interface de programmation (API) REST avec Symfony :

    composer require "friendsofsymfony/rest-bundle"

Pour éviter de tester les API en copiant-collant leurs chemins dans une commande cURL ou des outils comme Postman, on peut installer une interface graphique ergonomique, qui peut également faire office de documentation :

    composer require "nelmio/api-doc-bundle"

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

app.swagger_ui:
    path: /api/doc
    methods: GET
    defaults: { _controller: nelmio_api_doc.controller.swagger_ui }

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

Sérialiseur

Enfin pour la sérialisation, on distingue plusieurs solutions :

  • symfony/serializer, qui donne des contrôleurs extends FOSRestController et des méthodes aux annotations @Rest\Post()[1].
  • jms/serializer-bundle, avec des contrôleurs extends RestController et des méthodes aux annotations @ApiDoc().
  • Le service fos_rest.service.serializer.

symfony/serializer

    composer require "symfony/serializer"

jms/serializer-bundle

    composer require "jms/serializer-bundle"

Références