C# Web API controller'larını ve DTO'larını, TypeScript/JavaScript tüketicileriyle çapraz referanslayarak sözleşme sapmalarını ve bozucu değişiklikleri tespit eder.
- GitHub yıldızları
- 41.038
- Dosyalar
- 1
- Son commit
- 11 Kas 2026
- Lisans
- MIT
- İzin verilen araçlar
- —
api-breaking-change-detector skill ne işe yarar?
C# Web API controller'larını ve DTO'larını, TypeScript/JavaScript tüketicileriyle çapraz referanslayarak sözleşme sapmalarını ve bozucu değişiklikleri tespit eder.
Özet, skill'in SKILL.md dosyasından oluşturuldu.
api-breaking-change-detector skilli hakkında
Bu SKILL, C# Web API controller'ları ile TypeScript veya JavaScript tüketicileri arasındaki sözleşme sapmalarını tespit etmenizi sağlar. Geliştiricilerin; JSON anahtarlarının yeniden adlandırılması veya yeni zorunlu parametreler gibi backend değişikliklerinin React, Angular veya Vue gibi istemci uygulamalarını ne zaman bozacağını belirlemelerine yardımcı olur. Ayrıca, frontend kodunun artık backend tarafından işlenmeyen alanları gönderdiği durumları tespit ederek, sessiz çalışma zamanı hatalarının canlı ortama ulaşmadan yakalanmasına yardımcı olur.
Bir kullanıcı, kodu birleştirmeden önce bir DTO veya controller değişikliğini tüketicilerine karşı denetlemek istediğinde bir agent bu aracı yüklemelidir. OpenAPI spesifikasyon dosyalarını karşılaştıran araçların aksine, bu SKILL doğrudan gerçek kaynak kodu üzerinde çalışır. JSON isimlendirme politikaları için Program.cs dosyasını analiz eder, C# 11 required değiştiricilerini inceler ve Fetch veya Axios kullanan elle yazılmış HTTP çağrılarını bulmak için normalize edilmiş URL eşleştirmesi kullanır. Süreç, herhangi bir dosyayı değiştirmek yerine ayrıntılı bir denetim raporu üretir.
Bir agent bununla neler yapabilir
- 1Bozucu etkiler için DTO değişikliklerini denetleyinBir C# Data Transfer Object (DTO) değişikliğinin mevcut frontend arayüzlerini bozup bozmayacağını kontrol edin.
- 2API sözleşmesi senkronizasyonunu doğrulayınBackend controller'ları ile TypeScript istemci modellerinin senkronize kaldığından emin olun.
- 3Yayın öncesi endpoint denetimleri gerçekleştirinCanlıya çıkış öncesinde tüm API yüzeyini potansiyel bozucu değişikliklere karşı denetleyin.
Skill'in SKILL.md dosyasından yazılmıştır. Her kullanım durumu oradaki bir alıntı ile kontrol edilir.
api-breaking-change-detector skill nasıl kurulur
Her komut, skill klasörünü istemcinin skills dizinine kopyalar. Yüklemek için istemciyi yeniden başlatın veya yeni bir oturum başlatın.api-breaking-change-detector skill'ini Claude Code uygulamasına kur
~/.claude/skills/api-breaking-change-detector/SKILL.md
$ npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.claude/skills/api-breaking-change-detectorapi-breaking-change-detector skill'ini Claude Code (project) uygulamasına kur
.claude/skills/api-breaking-change-detector/SKILL.md
$ npx degit github/awesome-copilot/skills/api-breaking-change-detector .claude/skills/api-breaking-change-detectorapi-breaking-change-detector skill'ini Codex uygulamasına kur
~/.agents/skills/api-breaking-change-detector/SKILL.md
$ npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.agents/skills/api-breaking-change-detectorapi-breaking-change-detector skill'ini Gemini CLI uygulamasına kur
~/.gemini/skills/api-breaking-change-detector/SKILL.md
$ npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.gemini/skills/api-breaking-change-detectorapi-breaking-change-detector skill'ini Claude.ai uygulamasına kur
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
Otomatik kontroller
Çalıştırıldı 15 Kas 2026Tam rapor →Otomatik kontrollerimizi geçti. Bu bir güvenlik denetimi değil: bir ajanın çalıştırmasına izin vermeden önce betikleri okuyun. Kontroller nasıl çalışır
- Kaynak deposu bağlantılı ve erişilebilirgithub/awesome-copilot/skills/api-breaking-change-detector is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/api-break ↗Geçti
- Açık kaynak lisansı (OSI)MITspdx.org/licenses/MIT.html ↗Geçti
- Son bir yıl içinde commit veya sürüm mevcutLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Geçti
- Betiklerde indir-çalıştır veya kimlik bilgisi hırsızlığı yokNo scripts in the skill folderGeçti
- SKILL.md içinde gizli talimat yokNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Geçti
- Önceden izin verilen araçlar sınırlıNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Geçti
- SKILL.md, Agent Skills biçimine uyuyorValid name and description; says when to use it; 73 linesgithub.com/github/awesome-copilot/blob/HEAD/skills/api-break ↗Geçti
SKILL.md
GitHub'da görüntüleAPI 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.
Bu becerideki dosyalar
1api-breaking-change-detector skill soruları
api-breaking-change-detector skill'ini Claude Code uygulamasına nasıl kurarım?
npx degit github/awesome-copilot/skills/api-breaking-change-detector ~/.claude/skills/api-breaking-change-detector komutunu çalıştırın. Claude Code, skill'leri ~/.claude/skills (tüm projeler) veya .claude/skills (tek proje) konumundan yükler ve açıklaması görevle eşleştiğinde skill'i kullanır.
api-breaking-change-detector skill'ini hangi istemciler kullanabilir?
Agent Skills biçimini okuyan her istemci: Claude Code, Codex, Gemini CLI ve claude.ai (ZIP olarak yükleyin). Skill içindeki betikler yalnızca istemcinin kod çalıştırmaya izin verdiği yerlerde çalışır.
Bu araç karşılaştırma yapmak için OpenAPI spec dosyalarını mı kullanıyor?
Hayır, bu SKILL dışa aktarılmış OpenAPI spec dosyalarını kullanmak yerine doğrudan kaynak kodu üzerinden çalışır.
Ne tür frontend istemcileri denetlenebilir?
React, Angular, Vue, Svelte, Node.js gibi çeşitli TypeScript/JavaScript tüketicilerini ve Fetch, Axios veya NSwag kullanan istemcileri destekler.
Araç C# isimlendirme politikalarını nasıl işliyor?
camelCase gibi JSON isimlendirme politikaları için Program.cs veya Startup.cs dosyalarını kontrol eder ve açıkça belirtilen [JsonPropertyName] niteliklerine saygı duyar.
Bu araç kaynak kodumu değiştirir mi?
Hayır, araç yalnızca bir denetim raporu oluşturmak üzere tasarlanmıştır ve herhangi bir kod değişikliği yapmaz.