Api Versioning Strategies

---
name: api-versioning-strategies
description: "Use when versioning APIs."
version: 1.0.0
author: Hermes Agent
license: MIT
platforms: [linux, macos, windows]
metadata:
  hermes:
    tags: [api, api-versioning, backward-compatibility]
    related_skills: ['api-design-and-documentation']
---

## Overview
Version APIs using strategies that maintain backward compatibility and clear contracts.

## When to Use
- "Api Versioning Strategies implementation and design"
- "Best practices for Api Versioning Strategies"
- "Api Versioning Strategies deployment and scaling"
- "Api Versioning Strategies optimization and monitoring"

## Key Approaches
1. Define clear requirements and specifications
2. Choose appropriate tools and frameworks
3. Implement with modular, maintainable code
4. Write tests and automate verification
5. Document architecture and decisions
6. Monitor performance and iterate

## Common Pitfalls
1. **Not accounting for constraints** — resource or timeline limitations
2. **Ignoring industry standards** — not following established best practices
3. **Poor stakeholder alignment** — conflicting requirements
4. **Inadequate testing** — no validation of critical functions
5. **Not documenting decisions** — lost knowledge transfer
6. **Skipping security review** — no threat modeling performed
7. **Over-engineering** — complex solutions where simple ones suffice
8. **No rollback plan** — deployment failures cause outages
9. **Insufficient monitoring** — no observability after deployment
10. **Not planning for growth** — scalability issues in production

## Verification Checklist
- [ ] Requirements defined and validated
- [ ] Industry standards and best practices applied
- [ ] Design reviewed with stakeholders
- [ ] Implementation plan with milestones
- [ ] Testing strategy with coverage targets
- [ ] Security review and threat modeling
- [ ] Monitoring and alerting configured
- [ ] Documentation complete and accessible
- [ ] Deployment with rollback plan
- [ ] Post-deployment verification