api-compatibility-analyzer

Solid

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

AI & Automation 814 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 95/100

Stars 20%
97
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 | Tool | Purpose | Integration Method | |------|---------|-------------------| | OpenAPI-diff | Spec comparison | CLI | | Optic | API change detection | CLI | | Akita | Traffic-based detection | API | | swagger-diff | Swagger comparison | CLI | | Spectral | API linting | CLI ...

Details

Author
a5c-ai
Repository
a5c-ai/babysitter
Created
4 months ago
Last Updated
today
Language
JavaScript
License
MIT

Related Skills