0011-laravel-api-surface-evolution
CommunityEvolve APIs safely with versioned contracts
Software Engineering#deprecation#laravel#contract testing#backward compatibility#dto#api versioning#transformers
AuthorMrJmpl3
Version1.0.0
Installs0
System Documentation
What problem does it solve?
API providers need to change request and response shapes over time without breaking existing clients or causing uncontrolled regressions.
Core Features & Use Cases
- Versioning strategy: Use explicit URI or header-based versioning and bias changes toward additive updates.
- Versioned DTOs & transformers: Introduce versioned data transfer objects and map them from domain models/services so controllers stay thin.
- Deprecations and sunset planning: Deprecate fields in responses and documentation with clear timelines and visibility into ongoing usage.
- Compatibility testing: Maintain contract tests per API version and run backward-compatibility tests for common flows (e.g., stable endpoints used by existing client apps).
Quick Start
Ask an AI to propose a Laravel API evolution plan for a breaking change by introducing versioned DTOs/transformers, marking deprecated fields with a sunset timeline, and defining contract/backward-compatibility tests for both old and new response shapes.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: 0011-laravel-api-surface-evolution Download link: https://github.com/MrJmpl3/codex_____data_____configuration/archive/main.zip#0011-laravel-api-surface-evolution Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.