Ajouter une documentation à votre API Symfony

Aujourd’hui, nous allons voir comment mettre en place une documentation pour notre API (que vous pouvez retrouver dans l’article précédent).

Ceci va être ultra simple grâce au package NelmioApiDocBundle.

Installation#

Pour l’installer :

composer require nelmio/api-doc-bundle

Et voilà ! Vous pouvez maintenant déjà naviguer vers /api/doc pour voir la documentation de votre API.

Si ça ne fonctionne pas, c’est peut-être que Twig n’est pas installé. Dans ce cas, ajoutez-le :

composer require twig asset

Si cela ne fonctionne toujours pas, vous devez déclarer la route dans Symfony :

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

Résultat#

Ce qui devrait vous donner :

Documentation Swagger UI

Personnalisation de la documentation#

Si vous voulez en savoir plus sur la documentation de votre API afin de la customiser au maximum, vous pouvez consulter les spécifications du format : https://swagger.io/specification/.

Code source#

Vous pouvez retrouver le code source complet sur GitHub :
https://github.com/gponty/custom-api