java-api-consistency-validator
/java-api-consistency-validator
Validate API consistency between two versions of Java libraries. Use when you need to compare API behavior, signatures, and exceptions between Java library versions to identify breaking changes, incompatible modifications, and behavior differences. The skill performs static analysis of Java code, compares method signatures, class definitions, interface changes, parameter types, return types, exception declarations, and generates a detailed JSON report with breaking changes, warnings, and migration guidance. Supports Java libraries and packages.
- Author
- ArabelaTso ↗
- Repository
- Skills-4-SE ↗
- Licence
- Apache-2.0
- Last repository change
- 21.08.2026
Assessment and security
- Files in this package
- 2
- Scripts
- 1
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 21.08.2026, without references to retired models or APIs.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
- 1 scripts in this package. Review them before installing, as Claude may execute them.
Scripts: scripts/validate.py
What it does and when to use it
Validate API consistency between two versions of Java libraries. Use when you need to compare API behavior, signatures, and exceptions between Java library versions to identify breaking changes, incompatible modifications, and behavior differences. The skill performs static analysis of Java code, compares method signatures, class definitions, interface changes, parameter types, return types, exception declarations, and generates a detailed JSON report with breaking changes, warnings, and migration guidance. Supports Java libraries and packages.
Original author description
Validate API consistency between two versions of Java libraries. Use when you need to compare API behavior, signatures, and exceptions between Java library versions to identify breaking changes, incompatible modifications, and behavior differences. The skill performs static analysis of Java code, compares method signatures, class definitions, interface changes, parameter types, return types, exception declarations, and generates a detailed JSON report with breaking changes, warnings, and migration guidance. Supports Java libraries and packages.
How it works
- Overview
- Quick Start
- What Gets Validated
- Validation Report
- Usage
- Tips
SKILL.md preview
---
name: java-api-consistency-validator
description: Validate API consistency between two versions of Java libraries. Use when you need to compare API behavior, signatures, and exceptions between Java library versions to identify breaking changes, incompatible modifications, and behavior differences. The skill performs static analysis of Java code, compares method signatures, class definitions, interface changes, parameter types, return types, exception declarations, and generates a detailed JSON report with breaking changes, warnings, and migration guidance. Supports Java libraries and packages.
---
# Java API Consistency Validator
## Overview
This skill validates API consistency between two versions of Java libraries by comparing signatures, behavior, and exceptions. It identifies breaking changes, incompatible modifications, and provides detailed reports to guide safe API migration or upgrade.
## Quick Start
```bash
# Compare two versions of a Java library
python scripts/validate.py /path/to/old_version /path/to/new_version
# Specify output file
python scripts/validate.py old_lib/ new_lib/ --output report.json
```
## What Gets Validated
1. **Method Signatures** - Parameters, return types, modifiers
2. **Class Definitions** - Methods, inheritance, interfaces
3. **Interface Changes** - Method additions, removals
4. **Parameter Changes** - Added, removed, or modified parameters
5. **Return Type Changes** - Modified return types
6. **Exception Declarations** - throws clauses
7. **Removed APIs** - Deleted classes, interfaces, or methods
## Validation Report
The tool generates a JSON report with:
- **Breaking Changes**: API removals, incompatible modifications
- **Warnings**: Type changes, signature modifications
- **Info**: New additions, non-breaking changes
- **Summary**: Total issues by severity
Example report:
```json
{
"summary": {
"breaking_changes": 3,
"warnings": 5,
"info": 2
},
"breaking_changes": [
{
"type": "method_removed",
"class": "UserService",
"method": "getUser",
"severity": "breaking",
"message": "Method 'UserService.getUser' was removed"
}
]
}
```
## Usage
```bash
python scripts/validate.py <old_version_path> <new_version_path> [--output <report.json>]
```
The validator exits with code 1 if breaking changes are found, 0 otherwise.
## Tips
- Run validation before upgrading dependencies
- Review breaking changes carefully
- Check warnings for potential issues
- Use in CI/CD pipelines to catch API changes
- Compare against semantic versioning expectations
- Validate before releasing new library versions
Files in this package (2)
- SKILL.md 3 KB
- scripts/validate.py 9 KB
Versions
The database has no other skills named java-api-consistency-validator.
Database snapshot: 13.11.2026 · package version 4db0ce106dc5 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100python-api-consistency-validator
Validate API consistency between two versions of Python libraries. Use when you need to compare API behavior, signatures, and exceptions between library versions to identify breaking changes, incompatible modifications, and behavior differences. The skill performs static… - 95java-migration
Guide for upgrading Java projects between major versions (8→11→17→21→25). Use when user says "upgrade Java", "migrate to Java 25", "update Java version", or when modernizing legacy projects. - 100api-design-reviewer
Review REST API designs for quality, consistency, and breaking changes. Lints OpenAPI specs, generates scorecards, and detects breaking changes between versions. Use when designing APIs, reviewing contracts, or managing API versioning. - 95java-test-updater
Update Java test classes and methods to work with new code versions after refactoring or modifications. Use when code changes break existing tests due to signature changes, refactoring, or behavior modifications. Takes old and new code versions plus old tests as input, and… - 100linear-upgrade-migration
Upgrade Linear SDK versions and migrate breaking changes. Use when updating to a new SDK version, handling deprecations, or migrating between major Linear API versions. Trigger with phrases like "upgrade linear SDK", "linear SDK migration", "update linear", "linear breaking… - 100migrate
Identify breaking changes between custom element manifest versions and suggest migration steps. Use when the user asks to "migrate", "upgrade components", "find breaking changes", "compare manifests", "what changed between versions", or mentions "deprecation" or "migration guide".