Comparer les points d’accès API et détecter les incompatibilités
Les équipes de développement API doivent souvent détecter rapidement les incompatibilités entre deux versions de contrat. Ce workflow identifie de façon fiable la suppression de points d’accès ou l’ajout de nouveaux champs obligatoires. Une fois importé, il peut être déclenché via un webhook et fournit une évaluation structurée de la compatibilité. Ce processus fait gagner un temps précieux, limite les erreurs et renforce l’assurance qualité dans les projets API.
Conçu pour les développeurs, propriétaires d’API et équipes techniques, le API Breaking Change Checker permet de vérifier automatiquement la compatibilité des modifications apportées aux contrats API. Le workflow comprend trois nœuds connectés : un webhook reçoit par POST deux états d’API (chacun sous forme d’un tableau d’objets endpoint avec method, path et requiredFields). Un nœud de code analyse si des points d’accès ont été supprimés ou si de nouveaux champs obligatoires ont été ajoutés. Les résultats sont retournés sous forme de JSON structuré, listant explicitement les points d’accès et champs concernés en cas d’incompatibilité. Les entrées erronées ou incomplètes génèrent un message d’erreur clair. Aucune authentification externe n’est requise pour l’installation, mais il est recommandé d’activer l’authentification du webhook dans n8n avant la mise en production. Les données sont stockées dans n8n, il convient donc de respecter la confidentialité. Le workflow vérifie uniquement la suppression de points d’accès et l’ajout de champs obligatoires, sans comparaison avancée de schémas ou de types.
Image générée par IA
Installation
1. Importez le workflow dans n8n.
2. Ouvrez le workflow et vérifiez que tous les nœuds sont correctement connectés.
3. Lancez le listener de test et copiez l'URL de test affichée dans le nœud Webhook.
4. Envoyez une requête POST à cette URL de test avec un outil comme curl ou Postman (Content-Type : application/json, voir exemple ci-dessous).
5. Vérifiez le résultat. Après un test réussi, publiez/activez le workflow et utilisez l'URL de production du nœud Webhook.
6. Avant la mise en production, configurez l'authentification du webhook dans n8n pour empêcher tout accès non autorisé.
Utilisation
Format d'entrée :
```json
{
"before": [
{"method": "GET", "path": "/users", "requiredFields": ["id"]},
{"method": "POST", "path": "/users", "requiredFields": ["name"]}
],
"after": [
{"method": "GET", "path": "/users", "requiredFields": ["id"]},
{"method": "POST", "path": "/users", "requiredFields": ["name", "email"]}
]
}
```
Sortie attendue :
```json
{
"status": "breaking_changes",
"removed": [],
"added": [],
"newRequiredFields": [
{"endpoint": "POST /users", "fields": ["email"]}
]
}
```
Statut HTTP : 200
Cas d'erreur (ex. tableaux manquants) :
```json
{
"before": null,
"after": []
}
```
Réponse :
```json
{
"status": "error",
"message": "before und after müssen Arrays sein."
}
```
Statut HTTP : 200
Remarques :
- Seuls les chemins des points de terminaison, les méthodes et les nouveaux champs obligatoires sont comparés. Les modifications sur les champs optionnels ou les types de données ne sont pas détectées.
- L'authentification du webhook doit être configurée séparément dans n8n.
- L'exécution stocke les données dans n8n. La conservation et l'accès doivent être configurés en conséquence.
- Les règles de comparaison peuvent être ajustées dans le nœud Code.
Connexions et APIs nécessaires
Connexions API
Aucun identifiant API enregistré n'a été détecté dans le JSON du workflow. Vérifiez tout de même les webhooks, systèmes cibles, identifiants et la protection des données avant l'activation.
Nœuds
WebhookCodeRespond to Webhook
Test fonctionnel isolé réussi
Test fonctionnel isolé facultatif
Le flux de données isolé a été testé sans services externes ni identifiants.
✓ 5 tests réussisAfficher les cas testésMasquer les cas testés
✓ Cas normal avec données complètesVérifie le parcours standard complet avec des données d'exemple valides.Test fonctionnel isolé réussi✓ Variante ou cas limiteVérifie une variante valide ou un cas limite important.Test fonctionnel isolé réussi✓ Règle de traitement supplémentaireVérifie la règle de traitement métier supplémentaire de ce workflow.Test fonctionnel isolé réussi✓ Entrée invalide ou incomplèteVérifie que les données invalides ou incomplètes sont rejetées de façon contrôlée.Test fonctionnel isolé réussi✓ Entrée videVérifie qu'une requête vide reçoit une réponse contrôlée.Test fonctionnel isolé réussi
