Skip to content

a5c-ai/babysitter / library/specializations/code-migration-modernization/skills/api-compatibility-analyzer

api-compatibility-analyzer

Unverified

Analyze API changes for backward compatibility with breaking change detection and consumer impact assessment

API Compatibility Analyzer Skill

Analyzes API changes between versions to detect breaking changes, assess consumer impact, and suggest migration strategies.

Purpose

Enable API versioning management for:

  • Breaking change detection
  • Deprecation analysis
  • Version comparison
  • Consumer impact assessment
  • Migration path suggestion

Capabilities

1. Breaking Change Detection

  • Detect removed endpoints
  • Identify removed fields
  • Find type changes
  • Flag required field additions

2. Deprecation Analysis

  • Track deprecated endpoints
  • Monitor deprecation timelines
  • Identify usage of deprecated APIs
  • Plan sunset schedules

3. Version Comparison

  • Compare OpenAPI specs
  • Generate detailed diffs
  • Categorize changes
  • Document migrations

4. Consumer Impact Assessment

  • Map affected consumers
  • Estimate migration effort
  • Identify high-impact changes
  • Prioritize notifications

5. Migration Path Suggestion

  • Recommend upgrade steps
  • Suggest compatibility layers
  • Propose versioning strategies
  • Design adapter patterns

6. Compatibility Layer Design

  • Design facade endpoints
  • Plan response translation
  • Handle version negotiation
  • Implement fallbacks

Tool Integrations

ToolPurposeIntegration Method
OpenAPI-diffSpec comparisonCLI
OpticAPI change detectionCLI
AkitaTraffic-based detectionAPI
swagger-diffSwagger comparisonCLI
SpectralAPI lintingCLI

Output Schema

{
  "analysisId": "string",
  "timestamp": "ISO8601",
  "versions": {
    "base": "string",
    "target": "string"
  },
  "changes": {
    "breaking": [
      {
        "type": "string",
        "path": "string",
        "description": "string",
        "migration": "string"
      }
    ],
    "nonBreaking": [],
    "deprecations": []
  },
  "impact": {
    "consumers": [],
    "severity": "string",
    "migrationEffort": "string"
  },
  "recommendations": []
}

Integration with Migration Processes

  • api-modernization: Compatibility verification
  • framework-upgrade: API impact analysis

Related Skills

  • api-inventory-scanner: Endpoint discovery
  • openapi-generator: Spec generation

Related Agents

  • api-modernization-architect: Versioning strategy
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 318kUpdated Claude CodeCodexUnverifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 318kUpdated Claude CodeCodexUnverifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 318kUpdated Claude CodeCodexUnverifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 318kUpdated Claude CodeCodexUnverifiedInstall