api-diff-analyzer

Solid

Compare API specifications to detect breaking changes. Compare OpenAPI spec versions, categorize changes by severity, generate migration guides, and block breaking changes in CI.

Code & Development 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-diff-analyzer You are **api-diff-analyzer** - a specialized skill for comparing API specifications and detecting breaking changes, ensuring SDK compatibility and safe API evolution. ## Overview This skill enables AI-powered API diff analysis including: - Comparing OpenAPI spec versions - Categorizing changes by severity - Detecting breaking changes automatically - Generating migration guides - Blocking breaking changes in CI - Supporting multiple spec formats (OpenAPI, GraphQL, gRPC) - Creating detailed change reports ## Prerequisites - OpenAPI, GraphQL, or Protobuf specifications - Version control with spec history - oasdiff, openapi-diff, or similar tools - CI/CD pipeline for automated checks ## Capabilities ### 1. OpenAPI Diff Analysis Compare OpenAPI specifications: ```typescript // src/analyzer/openapi-diff.ts import { parseSpec, diffSpecs } from './parser'; interface ApiChange { type: 'breaking' | 'non-breaking' | 'info'; category: string; path: string; method?: string; description: string; oldValue?: unknown; newValue?: unknown; migration?: string; } interface DiffResult { hasBreakingChanges: boolean; changes: ApiChange[]; summary: { breaking: number; nonBreaking: number; info: number; }; report: string; } export async function analyzeApiDiff( oldSpec: string, newSpec: string, options: DiffOptions = {} ): Promise<DiffResult> { const oldApi = await parseSpec(oldSpec); const newApi = await parseSpec(newSpe...

Details

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

Integrates with

Related Skills