une doc pour notre API Symfony

u

Aujourd’hui nous allons voir comment mettre en place une doc pour notre api (que vous pouvez retrouver dans l’article précédent : /2022/01/12/construire-sa-propre-api-avec-symfony/)

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

Pour l’installer :

composer require nelmio/api-doc-bundle

Et voilà, vous pouvez maintenant déjà naviguer dans /api/doc pour voir la doc de votre API.
Si ça ne fonctionne pas c’est que peut-être vous n’avez pas twig d’installé :

composer require twig asset

Et si ça ne fonctionne toujours pas c’est qu’il faut 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 }

Ce qui devrait vous donner :

Si vous voulez en savoir plus sur la documentation de votre API afin de la customisé au maximum, vous pouvez jeter un oeil aux spécifications du format : https://swagger.io/specification/

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

About the author

Guillaume

Add comment

Guillaume

Get in touch

Quickly communicate covalent niche markets for maintainable sources. Collaboratively harness resource sucking experiences whereas cost effective meta-services.