OpenParable
Skip to content
← Back to skills

API Compatibility Analyzer

Testing & Quality
api-compatibility-analyzer

API Compatibility Analyzer is an Agent Skill for testing & quality published in the a5c-ai/babysitter repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/a5c-ai/babysitter/blob/HEAD/library/specializations/code-migration-modernization/skills/api-compatibility-analyzer/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/api-compatibility-analyzer, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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