Documenter l’API REST Symfony avec NelmioAPIDoc

Documenter l'API REST Symfony avec Nelmio API Doc Bundle

Grâce à NelmioAPIDoc, il est possible de générer une documentation de type Swagger idéale pour une API REST. Le bundle récupère l’annotation ApiDoc() située en haut des contrôleurs et génère une belle documentation disponible en ligne.

La section suivante présente comment utiliser cette annotation.

Exemple d’annotation @ApiDoc

Le code suivant démontre comment spécifier la route de la ressource, une description, les données d’entrées et les codes de statut (statusCode) utilisés .

Exemple de documentation Swagger

Exemple de documentation pour API REST

Configuration pour NelmioApiDoc

Les parsers

Le bundle doit donc lire le code afin de créer la documentation correspondante. Pour se faire, des parsers doivent être utilisés. Dans l’exemple suivant, le parser JmsMetadataParser est spécifié dans l’annotation. Cela permet de lire les configurations de votre serializer JMS.

D’autres parsers sont disponibles. Voici un lien vers la référence officielle sur GitHub :

https://github.com/nelmio/NelmioApiDocBundle/tree/master/Parser

 

 

Comments

comments

0 réponses

Répondre

Want to join the discussion?
Feel free to contribute!

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *