laravel-api-surface-evolution

star 136

Evolve APIs safely using versioned DTOs/transformers, deprecations, and compatibility tests

jpcaparas By jpcaparas schedule Updated 11/3/2025

name: laravel:api-surface-evolution description: Evolve APIs safely using versioned DTOs/transformers, deprecations, and compatibility tests

API Surface Evolution

Design for change without breaking clients.

Versioning Strategy

  • Choose explicit versioning (URI /v1/... or header negotiation)
  • Default to additive changes; never break a released contract

DTOs & Transformers

  • Define versioned DTOs; map from models/services via transformers
  • Keep controller thin—validate → transform → respond

Deprecations

  • Mark fields as deprecated in docs and responses (e.g., headers)
  • Provide sunset timelines; add metrics to see remaining usage

Testing

  • Contract tests per version (request/response shapes)
  • Backward compatibility tests for commonly used flows
Install via CLI
npx skills add https://github.com/jpcaparas/superpowers-laravel --skill laravel-api-surface-evolution
Repository Details
star Stars 136
call_split Forks 0
navigation Branch main
article Path SKILL.md
More from Creator