Documentation technique

Projet et configuration

Utilisez les fonctionnalités disponibles dans la gestion de projet de manière à faciliter la transition entre v001 et v002.

API

Dans l’application Apidae, dans le menu Diffuser > Projets > projet > onglet Configuration technique, modifier la configuration technique pour basculer le champs « Version du format de sortie » de v001 à v002.

Modifier le traitement des données retournées pour prendre en compte les modifications apportées au flux (Liste des changements entre V1 et V2). Modifier les appels aux services d’API en renommant les paramètres qui ont pu changer de nom dans la v002 (voir les modifications dans les paramètres de requête d’API). Modifier les appels aux services d’API en remplaçant dans le chemin v001 par v002.

Exemple : l’appel
http://api.apidae-tourisme.com/api/v001/objet-touristique/get-by-id/100798
devient
http://api.apidae-tourisme.com/api/v002/objet-touristique/get-by-id/100798

Il est possible sur un projet d’utiliser de mmanière simultanée les service v001 et v002 pour faciliter votre migration.

Exports

Configuration

Dans l’application Apidae, dans le menu Diffuser > Projets > projet > onglet Configuration technique, modifier la configuration technique pour basculer le champs « Version du format de sortie » de v001 à v002.
Modifier le traitement des données pour prendre en compte les modifications apportées au flux (Documentation migration v001 à v002 – les formats).

Conseil de migration

Pour migrer votre projet progressivement vers la V2, sans interrompre le fonctionnement de vôtre projet V1 en production, il est possible de dupliquer le projet v001 pour créer un projet identique qui vous permettra de préparer le passage à la v002 (cette duplication doit être réalisée par votre client) :

  • Le nouveau projet peut être configuré séparément de l’ancien projet pour passer en v002.
  • Les sélections du nouveau projet sont liées aux sélections du projet v001.
  • Si le contenu d’une sélection du projet v001 est modifié, sa version dupliquée dans le projet v002 subira les mêmes modifications.

Attention, les sélections du nouveau projet n’ont pas le même id que les sélections du projet v001.
Les sélections ajoutées par la suite dans le projet original ne seront pas non plus ajoutées dans le nouveau projet (mais il est possible de le faire manuellement via le partage de sélection).

Une autre solution qui permet d’éviter de travailler avec de nouveaux identifiants de sélection :

  • Dupliquer le projet v001 pour créer un projet de test. Pour effectuer cette opération adressez-vous au propriétaire actuel du projet.
  • Passer le nouveau projet test en v002 sur la fiche projet.
  • Récupérer les archives des projets v001 et v002.
  • Utiliser le fichier des sélections du projet original (v001), dont le format ne change pas en v002. Ce fichier vous donnera pour chaque id de sélection dans le projet v001, la liste des identifiants des objets de la sélection.
  • Récupérer les objets au format v002 dans l’archive du projet v002, à partir des identifiants d’objets fournis par le fichier des sélections v001.
  • Une fois les tests / développements terminés sur le projet v002, basculer le projet v001 au format v002 et supprimer le projet dupliqué.

Cette solution vous permet de conserver votre projet v001 dans sa version actuelle, durant les tests et les développements nécessaires à la migration vers la v002. Elle permet également de conserver les identifiants des sélections du projet v001, si ceux-ci sont structurants pour votre application.