Effectue des recoupements entre les contrôleurs C# Web API et les DTO avec les consommateurs TypeScript/JavaScript pour détecter les dérives de contrat et les changements de rupture.
- Étoiles GitHub
- 41 038
- Fichiers
- 1
- Dernier commit
- 11 nov. 2026
- Licence
- MIT
- Outils autorisés
- —
Que fait la skill api-breaking-change-detector ?
Effectue des recoupements entre les contrôleurs C# Web API et les DTO avec les consommateurs TypeScript/JavaScript pour détecter les dérives de contrat et les changements de rupture.
Résumé généré à partir du SKILL.md de la skill.
À propos du skill api-breaking-change-detector
Ce SKILL permet de détecter les dérives de contrat entre les contrôleurs C# Web API et les consommateurs TypeScript ou JavaScript. Il aide les développeurs à identifier quand des changements backend, tels que le renommage de clés JSON ou l'ajout de nouveaux paramètres obligatoires, risquent de casser des applications clientes comme React, Angular ou Vue. Il identifie également lorsque le code frontend envoie des champs que le backend ne traite plus, aidant ainsi à détecter les bugs silencieux au moment de l'exécution avant qu'ils n'atteignent la production.
Un agent doit charger cet outil lorsqu'un utilisateur a besoin d'auditer la modification d'un DTO ou d'un contrôleur par rapport à ses consommateurs avant de fusionner le code. Contrairement aux outils qui comparent les fichiers de spécification OpenAPI, ce SKILL travaille directement sur le code source réel. Il analyse Program.cs pour les politiques de nommage JSON, inspecte les modificateurs required de C# 11 et utilise une correspondance d'URL normalisée pour trouver les appels HTTP écrits à la main via Fetch ou Axios. Le processus génère un rapport d'audit détaillé au lieu de modifier les fichiers.
Ce qu'un agent peut faire avec
- 1Auditer les changements de DTO pour identifier les impacts de ruptureVérifiez si la modification d'un Data Transfer Object en C# va casser les interfaces frontend existantes.
- 2Vérifier la synchronisation du contrat APIAssurez-vous que les contrôleurs backend et les modèles clients TypeScript restent synchronisés.
- 3Effectuer des audits de points de terminaison avant la mise en productionAuditez l'ensemble de la surface de l'API pour détecter d'éventuels changements de rupture avant une mise en production.
Rédigé à partir du SKILL.md du skill. Chaque cas d'utilisation est vérifié par rapport à une citation de celui-ci.
Comment installer la skill api-breaking-change-detector
Chaque commande copie le dossier de la skill dans le répertoire des skills du client. Redémarrez le client ou démarrez une nouvelle session pour la charger.Installer la skill api-breaking-change-detector dans Claude Code
~/.claude/skills/api-breaking-change-detector/SKILL.md
$ npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.claude/skills/api-breaking-change-detectorInstaller la skill api-breaking-change-detector dans Claude Code (project)
.claude/skills/api-breaking-change-detector/SKILL.md
$ npx degit github/awesome-copilot/skills/api-breaking-change-detector .claude/skills/api-breaking-change-detectorInstaller la skill api-breaking-change-detector dans Codex
~/.agents/skills/api-breaking-change-detector/SKILL.md
$ npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.agents/skills/api-breaking-change-detectorInstaller la skill api-breaking-change-detector dans Gemini CLI
~/.gemini/skills/api-breaking-change-detector/SKILL.md
$ npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.gemini/skills/api-breaking-change-detectorInstaller la skill api-breaking-change-detector dans Claude.ai
npx degit github/awesome-copilot/skills/api-breaking-change-detector api-breaking-change-detector && zip -r api-breaking-change-detector.zip api-breaking-change-detector # claude.ai → Customize → Skills → + → Create skill → Upload a skill → api-breaking-change-detector.zip
Vérifications automatisées
Exécuté le 15 nov. 2026Rapport complet →A réussi nos vérifications automatiques. Ce n'est pas un audit de sécurité : lisez les scripts avant de laisser un agent les exécuter. Fonctionnement des vérifications
- Dépôt source lié et accessiblegithub/awesome-copilot/skills/api-breaking-change-detector is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/api-break ↗Réussi
- Licence open source (OSI)MITspdx.org/licenses/MIT.html ↗Réussi
- Commit ou version publiée au cours de l'année écouléeLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Réussi
- Aucun téléchargement-exécution ni vol d'identifiants dans les scriptsNo scripts in the skill folderRéussi
- Aucune instruction cachée dans SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Réussi
- Les outils préautorisés sont limitésNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Réussi
- SKILL.md respecte le format Agent SkillsValid name and description; says when to use it; 73 linesgithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Réussi
SKILL.md
Voir sur GitHubAPI Breaking Change Detector
You are cross-referencing a C# Web API's actual contract (controllers, DTOs, route definitions) against its TypeScript/JavaScript consumers to find contract drift — in both directions — before it reaches production.
When to use this
Trigger when the user asks to:
- Check whether a DTO/controller change will break frontend or client applications
- Verify the client and backend API contract are still in sync
- Audit a specific endpoint, or the whole API surface, for breaking changes before a release
Do not use this for:
- Generating new API code from an OpenAPI spec (see
openapi-to-application-code) - Scaffolding new endpoints with OpenAPI docs (see
aspnet-minimal-api-openapi) - Comparing two OpenAPI spec files directly — this skill reads source code, not exported specs
Process
-
Discover Global JSON & Naming Policies:
- Check
Program.csorStartup.csfor active JSON options (e.g.JsonNamingPolicy.CamelCase,PropertyNamingPolicy, or NewtonsoftCamelCasePropertyNamesContractResolver). - Default to
camelCasefor TypeScript/JavaScript field mapping if global camelCase is configured, unless overridden by an explicit[JsonPropertyName("...")]attribute on the C# property. - Ignore C# properties annotated with
[JsonIgnore].
- Check
-
Identify the C# contract surface. For each Controller action in scope:
- Route: Base
[Route("...")]+ action[HttpGet("...")]/[HttpPost("...")]. Normalize route parameters (e.g.{id:int}or{id:guid}$\rightarrow${id}). - Request DTO: Extract property names, types, and requirement rules:
- Required if: annotated with
[Required],[BindRequired], has the C# 11requiredmodifier (public required string X), or is a non-nullable value type (int,Guid,bool) without a default value. - Optional if: nullable (
string?,int?), or has a default initializer.
- Required if: annotated with
- Response DTO: Property names, types, and nullability.
- Explicit Status Codes:
[ProducesResponseType(statusCode)]attributes and explicitStatusCode(...)return paths.
- Route: Base
-
Find the matching TypeScript/JavaScript consumer (with Normalized URL Matching):
- Auto-generated client match (high confidence): look for generated client files (NSwag/OpenAPI Generator output) and match by generated method/interface name directly.
- Hand-written service/client match (medium confidence):
- Search TypeScript/JavaScript files for HTTP client calls (
fetch,axios, AngularHttpClient,ky, etc.) whose normalized URL pattern matches the controller's route. - Normalize template strings and concatenations (e.g.,
${this.apiUrl}/users/${id}orbaseUrl + '/users/' + userId$\rightarrow$/users/{id}). - Match normalized routes against C# routes regardless of variable naming in TypeScript/JS.
- Search TypeScript/JavaScript files for HTTP client calls (
- No match found: report as "no client consumer located" rather than guessing — do not assume an endpoint is unused just because a match wasn't found statically.
- Label every finding with which of these three methods was used to locate it.
-
Compare backend → frontend/client (breaks the client):
- A DTO property renamed or removed that the TypeScript/JS interface or object model still expects
- A new required request field the client never sends
- A response status code the client doesn't handle (e.g. controller now returns 409 Conflict, but client error handler only handles 400/500)
- A response field's type changed (e.g.
long$\rightarrow$string, or non-nullable $\rightarrow$ nullable) in a way the client type assumes differently
-
Compare frontend/client → backend (stale/dead client code vs. silent bugs):
- Harmless dead field: Client sends a payload property the backend ignores without error.
- Silently broken bug (High Severity): Client logic reads a response property that the backend no longer returns (resulting in
undefinedat runtime and potential application failures).
-
Produce the report (see Output Format). This skill does not modify code.
Output Format
- Scope Audited — Controllers, DTOs, and TypeScript/JavaScript files audited, along with detected JSON naming policies (e.g.
camelCaseenabled viaProgram.cs). - Backend → Client Breaks — Grouped by endpoint: what changed, match method used (Auto-generated / Normalized Route Match), exact impact on the client, and severity (Compilation Error vs. Silent Runtime Failure).
- Client → Backend Drift — Stale fields sent or expected, explicitly distinguishing harmless dead fields from silently broken client UI logic.
- No Consumer Found — Unmatched backend DTOs/endpoints requiring manual confirmation.
- Match Confidence Summary — Breakdown of findings derived from auto-generated clients vs. normalized hand-written routes vs. unmatched routes.
Guidelines
- URL Normalization: Always strip query parameters (
?status=active) and normalize path parameters (${id}/:id/{id}) before comparing routes. - Naming Policies: Never assume a C# property name matches a TypeScript/JS property verbatim without checking for
[JsonPropertyName("...")]or globalJsonNamingPolicy.CamelCasesettings. - Modern C# Nuances: Check for C# 11
requiredkeyword and#nullable enableannotations (string?vsstring) when assessing required properties. - Framework Agnostic: Apply contract matching across any TypeScript or JavaScript client (Fetch, Axios, Angular, React, Vue, Svelte, Node.js).
- Never Fabricate: If no matching client service or DTO is found, report "No consumer located via static search" — never guess a pairing based purely on loose class names.
- Reporting Only: Do not modify code; output a scannable, actionable audit report.
Fichiers de cette skill
1Questions sur la skill api-breaking-change-detector
Comment installer la skill api-breaking-change-detector dans Claude Code ?
Exécutez npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.claude/skills/api-breaking-change-detector. Claude Code charge les skills depuis ~/.claude/skills (tous les projets) ou .claude/skills (un seul projet) et utilise une skill lorsque sa description correspond à la tâche.
Quels clients peuvent utiliser la skill api-breaking-change-detector ?
Tout client qui lit le format Agent Skills : Claude Code, Codex, Gemini CLI et claude.ai (envoi sous forme de ZIP). Les scripts de la skill ne s'exécutent que si le client autorise l'exécution de code.
Cet outil utilise-t-il des fichiers de spécification OpenAPI pour la comparaison ?
Non, ce SKILL travaille directement sur le code source plutôt que d'utiliser des fichiers de spécification OpenAPI exportés.
Quels types de clients frontend peuvent être audités ?
Il prend en charge divers consommateurs TypeScript/JavaScript, notamment React, Angular, Vue, Svelte, Node.js, ainsi que les clients utilisant Fetch, Axios ou NSwag.
Comment l'outil gère-t-il les politiques de nommage C# ?
Il vérifie Program.cs ou Startup.cs pour les politiques de nommage JSON comme le camelCase et respecte les attributs explicites [JsonPropertyName].
Cet outil modifiera-t-il mon code source ?
Non, l'outil est conçu pour produire uniquement un rapport d'audit et n'effectue aucune modification de code.