api-versioning-and-compatibility
Design APIs and contracts for safe evolution, backward compatibility, and clear versioning strategies. Use when releasing public or internal APIs that will have multiple consumers over time.
- License 许可
- MIT
- 最近更新
- 2026-07-22
- Stars
- ★ 7
- Forks
- 1
01 前言 Front Matter
- name
- api-versioning-and-compatibility
- description
- Design APIs and contracts for safe evolution, backward compatibility, and clear versioning strategies. Use when releasing public or internal APIs that will have multiple consumers over time.
03 SKILL.md 正文
API Versioning and Compatibility
Overview
Changing an API after consumers depend on it is expensive. Design for evolution from the start.
When to Use
- Designing new public or widely-used internal APIs
- Making changes to existing contracts
- Choosing between URL versioning, header versioning, or evolutionary approaches
Strategies
- Backward-compatible changes whenever possible (add fields, don’t remove or redefine)
- Explicit versioning (URL path, header, or media type) when breaking changes are required
- Deprecation windows and clear communication
- Consumer-driven contract testing where justified
Principles
- Prefer additive, non-breaking changes
- Document compatibility guarantees
- Make breaking changes rare, explicit, and well-communicated
- Version only when necessary — excessive versioning has its own costs
Verification
- Compatibility expectations are documented
- Breaking changes follow a clear process
- Consumers have a realistic migration path
04 同仓库更多 Skills
compliance-monitoring
Design compliance monitoring and testing programs that verify controls work in practice and surface issues before regulators do. Use when building monitoring plans, compliance testing, or continuous control monitoring.
complaints-handling
Operate complaints-handling processes that meet regulatory standards — logging, timely resolution, root-cause analysis, and fair outcomes. Use when designing or improving regulated complaints frameworks or analyzing complaint themes for conduct risk.
aml-kyc-basics
Apply AML/KYC fundamentals — customer due diligence, monitoring, suspicious activity escalation, and recordkeeping — for financial crime compliance. Use when designing onboarding controls, transaction monitoring concepts, or AML program components in financial services.
ai-model-compliance
Apply compliance controls to AI and automated decision systems — transparency, fairness, human oversight, documentation, and regulatory alignment. Use when deploying AI in regulated processes (credit, fraud, customer decisions) or responding to AI governance expectations.
data-quality-management
Manage data quality end-to-end — dimensions, rules, remediation, and prevention — beyond one-off cleaning scripts. Use when building sustained data quality programs or fixing systemic accuracy, completeness, or consistency problems.
data-lineage
Capture and use data lineage — where data comes from, how it transforms, and what depends on it — for impact analysis, debugging, and trust. Use when tracing metric origins, assessing change impact, or diagnosing broken pipelines.