Cruza controladores de Web API em C# e DTOs com consumidores em TypeScript/JavaScript para detectar desvios de contrato e breaking changes.
- Estrelas no GitHub
- 41.038
- Arquivos
- 1
- Último commit
- 11 de nov. de 2026
- Licença
- MIT
- Ferramentas permitidas
- —
O que a skill api-breaking-change-detector faz?
Cruza controladores de Web API em C# e DTOs com consumidores em TypeScript/JavaScript para detectar desvios de contrato e breaking changes.
Resumo gerado a partir do SKILL.md da skill.
Sobre a skill api-breaking-change-detector
Esta SKILL permite detectar o desvio de contrato entre controladores de Web API em C# e consumidores em TypeScript ou JavaScript. Ela ajuda desenvolvedores a identificar quando mudanças no backend, como chaves JSON renomeadas ou novos parâmetros obrigatórios, irão quebrar aplicações cliente como React, Angular ou Vue. Também identifica quando o código frontend envia campos que o backend não processa mais, ajudando a capturar bugs silenciosos de runtime antes que cheguem à produção.
Um agente deve carregar esta ferramenta quando um usuário precisar auditar uma mudança de DTO ou controlador em relação aos seus consumidores antes de realizar o merge do código. Diferente de ferramentas que comparam arquivos de especificação OpenAPI, esta SKILL trabalha diretamente com o código-fonte real. Ela analisa o Program.cs em busca de políticas de nomenclatura JSON, inspeciona modificadores required do C# 11 e utiliza correspondência de URL normalizada para encontrar chamadas HTTP escritas manualmente usando Fetch ou Axios. O processo gera um relatório de auditoria detalhado em vez de modificar qualquer arquivo.
O que um agente pode fazer com ela
- 1Auditar mudanças de DTO para impactos de breaking changesVerifique se a modificação de um Data Transfer Object em C# irá quebrar interfaces frontend existentes.
- 2Verificar a sincronização do contrato da APIGaranta que os controladores do backend e os modelos do cliente TypeScript permaneçam sincronizados.
- 3Realizar auditorias de endpoints pré-lançamentoAudite toda a superfície da API em busca de possíveis breaking changes antes de um lançamento em produção.
Escrito a partir do SKILL.md da skill. Cada caso de uso é verificado com uma citação dele.
Como instalar a skill api-breaking-change-detector
Cada comando copia a pasta da skill para o diretório de skills do cliente. Reinicie o cliente ou inicie uma nova sessão para carregá-la.Instalar a skill api-breaking-change-detector no 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 a skill api-breaking-change-detector no 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 a skill api-breaking-change-detector no 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 a skill api-breaking-change-detector no 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 a skill api-breaking-change-detector no 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
Verificações automatizadas
Executado em 15 de nov. de 2026Relatório completo →Passou nas nossas verificações automáticas. Não é uma auditoria de segurança: leia os scripts antes de deixar um agente executá-los. Como as verificações funcionam
- Repositório de origem vinculado e acessívelgithub/awesome-copilot/skills/api-breaking-change-detector is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/api-break ↗Passou
- Licença de código aberto (OSI)MITspdx.org/licenses/MIT.html ↗Passou
- Commit ou release no último anoLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Passou
- Sem baixar e executar nem roubo de credenciais nos scriptsNo scripts in the skill folderPassou
- Sem instruções ocultas no SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Passou
- Ferramentas pré-aprovadas são restritasNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Passou
- O SKILL.md segue o formato Agent SkillsValid name and description; says when to use it; 73 linesgithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Passou
SKILL.md
Ver no 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.
Arquivos desta skill
1Perguntas sobre a skill api-breaking-change-detector
Como instalo a skill api-breaking-change-detector no Claude Code?
Execute npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.claude/skills/api-breaking-change-detector. O Claude Code carrega skills de ~/.claude/skills (todos os projetos) ou .claude/skills (um projeto) e usa uma skill quando a descrição dela corresponde à tarefa.
Quais clientes podem usar a skill api-breaking-change-detector?
Qualquer cliente que leia o formato Agent Skills: Claude Code, Codex, Gemini CLI e claude.ai (envie como ZIP). Scripts da skill são executados apenas onde o cliente permite execução de código.
Esta ferramenta utiliza arquivos de especificação OpenAPI para comparação?
Não, esta SKILL trabalha diretamente com o código-fonte em vez de usar arquivos de especificação OpenAPI exportados.
Que tipo de clientes frontend podem ser auditados?
Ela suporta vários consumidores TypeScript/JavaScript, incluindo React, Angular, Vue, Svelte, Node.js e clientes que utilizam Fetch, Axios ou NSwag.
Como a ferramenta lida com políticas de nomenclatura de C#?
Ela verifica o Program.cs ou Startup.cs em busca de políticas de nomenclatura JSON, como camelCase, e respeita atributos [JsonPropertyName] explícitos.
Esta ferramenta irá modificar meu código-fonte?
Não, a ferramenta foi projetada para gerar apenas um relatório de auditoria e não realiza nenhuma modificação no código.