Сверяет контроллеры C# Web API и DTO с потребителями на TypeScript/JavaScript для обнаружения расхождений в контрактах и ломающих изменений.
- Звёзды на GitHub
- 41 038
- Файлы
- 1
- Последний коммит
- 11 нояб. 2026 г.
- Лицензия
- MIT
- Разрешённые инструменты
- —
Что делает навык api-breaking-change-detector?
Сверяет контроллеры C# Web API и DTO с потребителями на TypeScript/JavaScript для обнаружения расхождений в контрактах и ломающих изменений.
Сводка сгенерирована из SKILL.md навыка.
О skill api-breaking-change-detector
Этот SKILL позволяет обнаруживать расхождения в контрактах между контроллерами C# Web API и потребителями на TypeScript или JavaScript. Он помогает разработчикам понять, когда изменения в бэкенде — например, переименование ключей JSON или добавление новых обязательных параметров — приведут к поломке клиентских приложений, таких как React, Angular или Vue. Также он выявляет случаи, когда фронтенд отправляет поля, которые бэкенд больше не обрабатывает, что помогает отловить скрытые ошибки времени выполнения до того, как они попадут в продакшн.
Агенту следует загружать этот инструмент, когда пользователю необходимо проверить изменения в DTO или контроллере на соответствие потребителям перед слиянием кода. В отличие от инструментов, которые сравнивают файлы спецификаций OpenAPI, этот SKILL работает напрямую с фактическим исходным кодом. Он анализирует Program.cs на предмет политик именования JSON, проверяет модификаторы required в C# 11 и использует нормализованное сопоставление URL для поиска написанных вручную HTTP-вызовов через Fetch или Axios. Процесс завершается созданием подробного отчета об аудите, не изменяя при этом файлы.
Что агент может делать с ним
- 1Аудит изменений DTO на предмет ломающих воздействийПроверьте, приведет ли изменение Data Transfer Object в C# к поломке существующих фронтенд-интерфейсов.
- 2Проверка синхронизации контрактов APIУбедитесь, что контроллеры бэкенда и модели TypeScript-клиента остаются синхронизированными.
- 3Проведение аудита эндпоинтов перед релизомПроведите аудит всей поверхности API на наличие потенциальных ломающих изменений перед выпуском в продакшн.
Написано на основе skill SKILL.md. Каждый сценарий использования проверен по цитате из него.
Как установить навык api-breaking-change-detector
Каждая команда копирует папку навыка в каталог навыков клиента. Перезапустите клиент или начните новую сессию, чтобы загрузить его.Установка навыка api-breaking-change-detector в 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-detectorУстановка навыка api-breaking-change-detector в 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-detectorУстановка навыка api-breaking-change-detector в Codex
~/.agents/skills/api-breaking-change-detector/SKILL.md
$ npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.agents/skills/api-breaking-change-detectorУстановка навыка api-breaking-change-detector в 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-detectorУстановка навыка api-breaking-change-detector в 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
Автоматические проверки
Запущено 15 нояб. 2026 г.Полный отчёт →Прошёл наши автоматические проверки. Это не аудит безопасности: прочитайте скрипты, прежде чем агент их запустит. Как работают проверки
- Связанный и доступный исходный репозиторийgithub/awesome-copilot/skills/api-breaking-change-detector is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/api-break ↗Пройдено
- Open source лицензия (OSI)MITspdx.org/licenses/MIT.html ↗Пройдено
- Коммит или релиз за последний годLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Пройдено
- В скриптах нет загрузки с запуском и кражи учётных данныхNo scripts in the skill folderПройдено
- В SKILL.md нет скрытых инструкцийNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Пройдено
- Заранее разрешённые инструменты ограниченыNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Пройдено
- SKILL.md соответствует формату Agent SkillsValid name and description; says when to use it; 73 linesgithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Пройдено
SKILL.md
Открыть на 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.
Файлы в этом навыке
1Вопросы о навыке api-breaking-change-detector
Как установить навык api-breaking-change-detector в Claude Code?
Выполните npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.claude/skills/api-breaking-change-detector. Claude Code загружает навыки из ~/.claude/skills (все проекты) или .claude/skills (один проект) и использует навык, когда его описание соответствует задаче.
Какие клиенты могут использовать навык api-breaking-change-detector?
Любой клиент, который читает формат Agent Skills: Claude Code, Codex, Gemini CLI и claude.ai (загрузить как ZIP). Скрипты в навыке выполняются только там, где клиент разрешает выполнение кода.
Использует ли этот инструмент файлы спецификаций OpenAPI для сравнения?
Нет, этот SKILL работает напрямую с исходным кодом, а не с экспортированными файлами спецификаций OpenAPI.
Какие фронтенд-клиенты можно проверить?
Поддерживаются различные потребители на TypeScript/JavaScript, включая React, Angular, Vue, Svelte, Node.js, а также клиенты, использующие Fetch, Axios или NSwag.
Как инструмент учитывает политики именования в C#?
Он проверяет Program.cs или Startup.cs на наличие политик именования JSON (например, camelCase) и учитывает явные атрибуты [JsonPropertyName].
Будет ли этот инструмент изменять мой исходный код?
Нет, инструмент предназначен только для создания отчета об аудите и не вносит никаких изменений в код.