La section servers
💡 Sujet
La section servers définit les URLs de base où l'API est accessible. Cela permet aux outils de test (comme Swagger UI) d'exécuter des requêtes directement contre les bons environnements.
⚙️ Configuration Multi-environnements
On peut lister plusieurs serveurs pour faciliter le passage du développement à la production :
servers:
- url: https://api.exemple.com/v1
description: Serveur de production
- url: https://staging-api.exemple.com
description: Serveur de test (Staging)
- url: http://localhost:8080
description: Serveur local🔄 Variables de serveur
Il est possible d'utiliser des variables pour rendre les URLs dynamiques :
servers:
- url: https://{username}.exemple.com/v1
variables:
username:
default: demo
description: Nom d'utilisateur pour l'instance sandbox.🧩 Résumé
- Flexibilité : Permet de tester l'API sans changer manuellement l'URL.
- Documentation : Clarifie où envoyer les requêtes pour chaque phase du projet.
- Variables : Utile pour les architectures SaaS ou les instances par client.