Notes sur la migration

Introduction

Cette page a pour but d'aider les développeurs à comprendre le processus de transfert, de mise à jour et de gestion des notes dans une architecture REST.

Que vous cherchiez à mettre à niveau votre API existante, à modifier les systèmes backend ou simplement à réorganiser votre structure de données, ce guide fournit des instructions complètes et les meilleures pratiques pour garantir une migration fluide et efficace. Notre objectif est de vous fournir les connaissances et les outils nécessaires pour gérer cet aspect crucial de la maintenance de l'API de manière transparente.

À propos des changements importants

L'API REST Club Med est versionnée. La version est reflétée sur chaque route de /v0 à vN.

Par exemple, notre route principale d'informations sur les produits existe dans /v0/products et /v1/products, mais notre documentation swagger n'affiche que la dernière version de l'API (par défaut).

Nous ne créons pas de version globale pour toutes les routes, chaque route a sa propre version.

Tout changement important sera publié dans une nouvelle version de l'API. Les changements importants sont des changements qui peuvent potentiellement casser une intégration. Les changements importants comprennent :

• la suppression d'une opération entière
• la suppression ou le renommage d'un paramètre
• la suppression ou le renommage d'un champ de réponse
• l'ajout d'un nouveau paramètre obligatoire
• le fait de rendre obligatoire un paramètre auparavant facultatif
• la modification du type d'un paramètre ou d'un champ de réponse
• la suppression de valeurs enum
• l'ajout d'une nouvelle règle de validation à un paramètre existant
• la modification des exigences d'authentification ou d'autorisation

Tout changement additif (non destructif) sera disponible dans toutes les versions d'API prises en charge. Les changements additifs sont des changements qui ne devraient pas casser une intégration. Les changements additifs comprennent :

• l'ajout d'une opération
• l'ajout d'un paramètre facultatif
• l'ajout d'un en-tête de requête facultatif
• l'ajout d'un champ de réponse
• l'ajout d'un en-tête de réponse
• l'ajout de valeurs enum

Lorsqu'une nouvelle version de l'API REST est publiée, la version précédente de l'API sera prise en charge pendant au moins 6 mois après la publication de la nouvelle version d'une route.

Changements importants

Voici les routes qui seront supprimées à l'avenir. Veuillez vous assurer de mettre à jour votre code en conséquence.