Rédiger les bonnes pratiques #36

Voir trello

Pour l’instant, aucune documentation publique n’est disponible pour l'écriture et le déploiement des services web.

Certaines de ces pratiques sont déjà connues (Pascal avait commencé à prendre des notes sur le déploiement d’un service), mais d’autres apparaissent au fur et à mesure.

Nous aurions intérêt à les partager.

Ex:

• utiliser un environnement virtuel quand on développe en python
• mettre dans requirements.txt tous les paquets qu’on utilise (grâce à pip freeze)
• mettre la version exacte des paquets dans requirements.txt
• documenter quelle version de python utiliser (lodex-workers-python@4.0.13 donne accès à python 3.10, alors que la version 4.0.11 utilise python 3.9, ce qui peut être important pour certains paquets PIP)
• ajouter systématiquement au moins un exemple d’un nouveau service dans le fichier examples.http qui correspond
• tester le swagger (avec exemples)
• vérifier avant de déployer en production que des exemples ont été ajouté dans les métadonnées du .ini, et que ces exemples sont correctes dans le swagger de la vi
• vérifier que le web service qu’on veut mettre à jour n’est pas utilisé (grafana) avant de déployer une nouvelle version
• prévenir Léo quand on a déployé un nouveau service, pour l’intégrer dans les catalogues de lodex
• publier la documentation dans Objectif TDM
• …

Rédiger les bonnes pratiques