Aller au contenu

Spécification OpenAPI

L’API Apprise inclut une spécification OpenAPI 3 dans le fichier swagger.yaml à la racine du dépôt, ici.

Pour le développement local ou l’exploration de l’API, vous pouvez lancer une instance autonome de Swagger UI qui lit le fichier de spécification sans modifier le fonctionnement de l’API Apprise principale.

Utilisez le fichier compose Swagger fourni dans le dépôt :

Fenêtre de terminal
docker compose -f docker-compose.swagger.yml up -d

Accédez ensuite à : http://localhost:8001

Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ? Signalez-la ou proposez une correction .

Problèmes Techniques

Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :

Conçu avec amour depuis le Canada