Outils et scripts IA
API Change Report : ce qui peut casser chez les consommateurs de votre API, à partir de deux spécifications
Pour les équipes d'API et les agences : un script compare votre ancien et votre nouveau fichier OpenAPI ou Swagger selon des règles fixes, et votre agent rédige un rapport des changements potentiellement incompatibles, un guide de migration, une entrée de journal des modifications et un avis pour les intégrateurs, que vous relisez. Rapport de ce qui peut casser chez les consommateurs de l'API entre deux versions.
Ce que vous recevez : 1 fichier · 76.62 KB · ZIP
Voir les options d'achatDescription du produit
Description
Pour les développeurs backend, équipes d'API et agences qui publient une nouvelle version d'une API HTTP et doivent dire à ceux qui l'appellent ce qui a changé.
Donnez à votre agent l'ancienne et la nouvelle description de votre API (OpenAPI 3.x ou Swagger 2.0, JSON ou YAML). L'agent rédige un rapport de changements, un guide de migration et un avis pour les intégrateurs, que vous relisez avant de publier.
Le rapport liste les changements potentiellement incompatibles trouvés en comparant les deux fichiers. C'est un point de départ pour la relecture de votre équipe, pas une évaluation de compatibilité confirmée.
Un script fourni compare les deux fichiers et classe chaque différence selon des règles fixes. L'agent écrit ensuite ce que chaque changement signifie pour un client : ce qu'il verra et ce qu'il devra modifier.
Ce que l'agent écrit à chaque exécution
changes.jsonetchanges.csv: chaque différence avec un identifiant, une classe (incompatible, potentiellement incompatible, compatible, documentation seulement), son type, la méthode et le chemin, ainsi que l'ancienne et la nouvelle valeur.change-report.mdetchange-report.html: les totaux du résumé, puis les changements incompatibles en premier, chacun avec son emplacement, ce qui a changé, ce qu'un client verra et ce qu'il faut modifier. Le HTML est une page imprimable sans fichier externe.migration-guide.md: des étapes pour les développeurs qui appellent l'API, avec des extraits avant et après tirés des deux fichiers.changelog-entry.md: une entrée de journal des modifications et une montée de version suggérée avec son raisonnement. C'est l'équipe qui décide.consumer-notice.md: une annonce brève et factuelle pour les intégrateurs.notes.md: ce qui a été comparé, ce que la comparaison de deux fichiers ne peut pas montrer et ce qui demande une décision.
Des règles, pas des suppositions
Le script connaît 118 types de changements répartis en quatre classes, avec des règles distinctes pour ce qu'un client envoie et ce qu'il reçoit : un nouveau champ obligatoire dans la requête est incompatible, un nouveau champ dans la réponse ne l'est pas. Il suit les $ref locaux. Lancez api_diff.py rules pour lire chaque règle. check confirme ensuite que chaque identifiant incompatible est couvert dans le rapport et dans le guide.
Vos faits uniquement
Le skill demande à l'agent de prendre les extraits, chemins et valeurs dans vos deux fichiers, et de marquer ce que vous n'avez pas fourni, comme une date d'arrêt de l'ancienne version, par [NEEDS: ...] au lieu de l'inventer.
Honnête sur ses limites
Il compare deux fichiers. Il n'appelle pas votre API, donc le comportement que la description n'indique pas échappe à sa vue. Les classes viennent de règles et c'est à votre équipe de les confirmer. Seuls les $ref locaux sont suivis : une spécification répartie sur plusieurs fichiers donne un avertissement et une comparaison incomplète. Le lecteur YAML couvre le sous-ensemble courant et indique la ligne lorsqu'il rencontre autre chose (convertissez ce fichier en JSON). Les expressions régulières et oneOf / anyOf sont signalées comme modifiées sans être évaluées. Les en-têtes de réponse, les liens, les callbacks et les webhooks ne sont pas comparés. Sans spécification, l'agent peut comparer une simple liste de points d'accès qu'il construit à partir de vos fichiers de routes ; ce chemin est plus faible et n'a pas été exécuté de bout en bout lors des tests. La page HTML a été vérifiée en lisant son code source, pas dans un navigateur.
Arabe
Sur demande, le rapport, le guide et l'avis sont rédigés en arabe et la page HTML est mise en page de droite à gauche, avec les chemins et le JSON de gauche à droite.
Dans le téléchargement : SKILL.md, quatre scripts Python en bibliothèque standard, références (les règles, comment rédiger chaque entrée, formats d'entrée, notes sur l'arabe), modèles et un exemple détaillé que vous pouvez lire avant d'acheter : une API de paiement qui passe de la 1.8.0 à la 2.0.0, avec 75 différences regroupées en 11 entrées incompatibles.
Testé sur deux cas (une API de paiement en OpenAPI 3 YAML en anglais ; une API de clinique en Swagger 2.0 JSON avec un rapport en arabe). Les scripts comptent 85 tests unitaires.
Version courte
Pour les développeurs backend et les équipes d'API qui publient une nouvelle version et doivent informer ses utilisateurs de ce qui a changé.
Donnez à votre agent le fichier de description de l'ancienne version et celui de la nouvelle (OpenAPI 3 ou Swagger 2, au format JSON ou YAML). Il rédige pour vous des brouillons du rapport de changements, du guide de migration et d'un avis pour les développeurs, que vous relisez avant de publier.
Ce que l'agent écrit
- Les fichiers
changes.jsonetchanges.csv: chaque différence avec son numéro, sa classe, son emplacement, ainsi que l'ancienne et la nouvelle valeur. - Le fichier
change-report: d'abord les changements incompatibles et, pour chacun, ce que le client verra et ce qu'il doit modifier. - Le fichier
migration-guide.md: des étapes de migration avec des extraits avant et après tirés de vos fichiers. - Les fichiers
changelog-entry.mdetconsumer-notice.md: l'entrée du journal des modifications et un court avis.
Ses limites
Les résultats sont des changements potentiellement incompatibles qui demandent la relecture de votre équipe. Le skill compare deux fichiers et n'appelle pas l'API, il ne voit donc pas ce que la description n'indique pas. La classification repose sur des règles fixes et c'est votre équipe qui la confirme. Il ne suit que les références à l'intérieur du même fichier. Le rapport peut être demandé en arabe avec une page de droite à gauche ; cela a été essayé sur un cas de test.
Questions
Quels formats lit-il ?
OpenAPI 3.x et Swagger 2.0, en JSON ou YAML. Le lecteur YAML couvre le sous-ensemble courant et indique la ligne s'il rencontre une fonctionnalité qu'il ne lit pas ; convertissez ce fichier en JSON.
Appelle-t-il mon API ?
Non. Il compare deux fichiers sur votre disque. Le comportement que la description n'indique pas échappe à sa vue.
Comment décide-t-il de ce qui est incompatible ?
Par des règles fixes que vous pouvez lire avec la commande rules : 118 types de changements en quatre classes, avec des règles distinctes pour ce qu'un client envoie et ce qu'il reçoit. Votre équipe confirme les classes.
Et si ma spécification est répartie sur plusieurs fichiers ?
Seules les références à l'intérieur du même fichier sont suivies. Regroupez d'abord la spécification en un seul fichier ; sinon vous obtenez un avertissement et une comparaison incomplète.
Va-t-il inventer une date d'arrêt ?
Le skill demande à l'agent de ne pas le faire. Les dates et calendriers que vous n'avez pas fournis sont marqués [NEEDS: ...] pour que vous les complétiez.
Le rapport peut-il être en arabe ?
Oui, en option, avec une page HTML de droite à gauche et des chemins conservés de gauche à droite. Cela a été essayé sur un cas de test ; relisez-le avant de publier.
Ce que vous recevez
1 fichier · 76.62 KB
- api-change-report-1.0.0.zipZIP · 76.62 KB
Outils et scripts IA
API Change Report : ce qui peut casser chez les consommateurs de votre API, à partir de deux spécifications
Pour les équipes d'API et les agences : un script compare votre ancien et votre nouveau fichier OpenAPI ou Swagger selon des règles fixes, et votre agent rédige un rapport des changements potentiellement incompatibles, un guide de migration, une entrée de journal des modifications et un avis pour les intégrateurs, que vous relisez. Rapport de ce qui peut casser chez les consommateurs de l'API entre deux versions.
Getly a ouvert les fichiers envoyés et n'a rien trouvé qui empêche leur ouverture. Ce n'est ni une analyse antivirus ni une note de qualité.
Tags
Questions fréquentes
Ai-je accès au produit immédiatement ?
Oui. C'est un produit numérique : vous pouvez le télécharger juste après le paiement, directement depuis votre bibliothèque.
Puis-je l'utiliser pour des projets commerciaux ?
Oui. L'usage commercial est autorisé : utilisez-le dans votre propre activité et dans ce que vous vendez. Vous ne pouvez pas revendre ni redistribuer le fichier lui-même.
Quelle est votre politique de remboursement ?
Vous pouvez demander un remboursement dans un délai de 30 jours. Si quelque chose ne va pas, demandez-le depuis votre commande et l'équipe Getly l'examine.
Quels formats et quelles tailles de fichier vais-je recevoir ?
Vous téléchargerez 1 fichier - ZIP - 76.62 KB au total.
Ai-je droit aux mises à jour gratuites ?
Oui : quand le vendeur publie une nouvelle version, vous pouvez retélécharger les derniers fichiers depuis votre bibliothèque sans frais. Consultez le journal des modifications pour les dernières mises à jour.
Prix
$7.00



