Documentation

Une documentation automatique de l'API a été mise en place. Elle doit ne pas être suivie par git, et donc être générée à chaque fois.

Générer la documentation

Veillez à avoir installé tous les paquets nécessaires via composer update. Ensuite, il faut demander à artisan de générer la documentation :

php artisan api:generate --routePrefix="api/"

Il faut compléter le préfixe de route en fonction de la documentation que l'on souhaite générer (ex : api/* pour toutes les routes, api/v1/* pour toutes les routes de la v1 de l'API).

Accéder à la documentation

La documentation est disponible dans le répertoire /public/docs/ ; on peut y accéder directement via le navigateur. Un fichier collection.json est également disponible pour importer les routes dans postman ou insomnia.

Mettre la documentation à jour

La commande pour mettre à jour la documentation est :

php artisan api:update