Realiza referencias cruzadas entre controladores de C# Web API y DTOs frente a consumidores en TypeScript/JavaScript para detectar desviaciones en el contrato y cambios que rompan la compatibilidad.
- Estrellas en GitHub
- 41.038
- Archivos
- 1
- Último commit
- 11 nov 2026
- Licencia
- MIT
- Herramientas permitidas
- —
¿Qué hace la skill api-breaking-change-detector?
Realiza referencias cruzadas entre controladores de C# Web API y DTOs frente a consumidores en TypeScript/JavaScript para detectar desviaciones en el contrato y cambios que rompan la compatibilidad.
Resumen generado a partir del SKILL.md de la skill.
Sobre la skill api-breaking-change-detector
Este SKILL permite detectar la desviación de contratos entre los controladores de C# Web API y los consumidores de TypeScript o JavaScript. Ayuda a los desarrolladores a identificar cuándo los cambios en el backend, como el renombramiento de claves JSON o nuevos parámetros obligatorios, romperán aplicaciones cliente como React, Angular o Vue. También identifica cuándo el código frontend envía campos que el backend ya no procesa, lo que ayuda a detectar errores silenciosos en tiempo de ejecución antes de que lleguen a producción.
Un agente debe cargar esta herramienta cuando un usuario necesite auditar un cambio en un DTO o controlador frente a sus consumidores antes de realizar un merge de código. A diferencia de las herramientas que comparan archivos de especificación OpenAPI, este SKILL trabaja directamente sobre el código fuente real. Analiza Program.cs para encontrar políticas de nomenclatura JSON, inspecciona los modificadores required de C# 11 y utiliza una coincidencia de URL normalizada para encontrar llamadas HTTP escritas a mano con Fetch o Axios. El proceso genera un informe de auditoría detallado en lugar de modificar archivos.
Lo que un agente puede hacer con ella
- 1Auditar cambios en DTOs para detectar impactos críticosComprueba si la modificación de un Data Transfer Object en C# romperá las interfaces frontend existentes.
- 2Verificar la sincronización del contrato de la APIAsegúrate de que los controladores del backend y los modelos del cliente TypeScript se mantengan sincronizados.
- 3Realizar auditorías de endpoints antes de un lanzamientoAudita toda la superficie de la API en busca de posibles cambios que rompan la compatibilidad antes de un despliegue a producción.
Escrito a partir del SKILL.md de la skill. Cada caso de uso se verifica con una cita del mismo.
Cómo instalar la skill api-breaking-change-detector
Cada comando copia la carpeta de la skill al directorio de skills del cliente. Reinicia el cliente o inicia una nueva sesión para cargarla.Instalar la skill api-breaking-change-detector en 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-detectorInstalar la skill api-breaking-change-detector en 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-detectorInstalar la skill api-breaking-change-detector en Codex
~/.agents/skills/api-breaking-change-detector/SKILL.md
$ npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.agents/skills/api-breaking-change-detectorInstalar la skill api-breaking-change-detector en 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-detectorInstalar la skill api-breaking-change-detector en 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
Verificaciones automáticas
Ejecutado 15 nov 2026Informe completo →Superó nuestras comprobaciones automáticas. No es una auditoría de seguridad: lee los scripts antes de dejar que un agente los ejecute. Cómo funcionan las verificaciones
- Repositorio de origen vinculado y accesiblegithub/awesome-copilot/skills/api-breaking-change-detector is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/api-break ↗Aprobado
- Licencia de código abierto (OSI)MITspdx.org/licenses/MIT.html ↗Aprobado
- Commit o lanzamiento en el último añoLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Aprobado
- Sin descargar y ejecutar ni robo de credenciales en los scriptsNo scripts in the skill folderAprobado
- Sin instrucciones ocultas en SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Aprobado
- Las herramientas preaprobadas están acotadasNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Aprobado
- SKILL.md sigue el formato de Agent SkillsValid name and description; says when to use it; 73 linesgithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Aprobado
SKILL.md
Ver en 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.
Archivos de esta skill
1Preguntas sobre la skill api-breaking-change-detector
¿Cómo instalo la skill api-breaking-change-detector en Claude Code?
Ejecuta npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.claude/skills/api-breaking-change-detector. Claude Code carga las skills desde ~/.claude/skills (todos los proyectos) o .claude/skills (un proyecto) y usa una skill cuando su descripción coincide con la tarea.
¿Qué clientes pueden usar la skill api-breaking-change-detector?
Cualquier cliente que lea el formato Agent Skills: Claude Code, Codex, Gemini CLI y claude.ai (subir como ZIP). Los scripts de la skill se ejecutan solo donde el cliente permite la ejecución de código.
¿Utiliza esta herramienta archivos de especificación OpenAPI para la comparación?
No, este SKILL trabaja directamente sobre el código fuente en lugar de utilizar archivos de especificación OpenAPI exportados.
¿Qué tipo de clientes frontend se pueden auditar?
Es compatible con varios consumidores de TypeScript/JavaScript, incluyendo React, Angular, Vue, Svelte, Node.js y clientes que utilizan Fetch, Axios o NSwag.
¿Cómo gestiona la herramienta las políticas de nomenclatura de C#?
Revisa Program.cs o Startup.cs para identificar políticas de nomenclatura JSON como camelCase y respeta los atributos explícitos [JsonPropertyName].
¿Modificará esta herramienta mi código fuente?
No, la herramienta está diseñada únicamente para generar un informe de auditoría y no realiza ninguna modificación en el código.