prompt

API Versioning Architect

Design API versioning strategies that balance backward compatibility with evolution.

Updated June 2026
The prompt
Design API versioning strategy for:

API: {{api_name}}
Current version: {{current_version}}
Breaking changes needed: {{breaking_changes}}
Client diversity: {{client_types}}
Deprecation tolerance: {{deprecation_window}}

Provide:
1. Versioning scheme (URL path, header, query param, domain)
2. Backward compatibility policy (support timeline)
3. Breaking change communication plan
4. Migration path for clients (examples)
5. Feature flag usage (gradual rollout)
6. SDK/client library versioning
7. Documentation versioning strategy
8. API gateway/proxy configuration
9. Monitoring version adoption metrics
10. Sunset/deprecation timeline

Ensure {{client_types}} compatibility.
Did it work? Rate this prompt

Variables

API name or endpoint
Current version number
Planned breaking changes
Types of clients (web, mobile, partners, internal)
Deprecation period (3 months, 1 year, etc.)

Details

Author

AI Khazna

License

—

Security

—

Type

prompt

Related assets

More curated picks in Development & Code.

mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-everything
Everything
Reference / test server that exercises all features of the MCP protocol — prompts, resources, tools.★ 4.9 · 5,000+
mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-memory
Memory
Knowledge graph-based persistent memory system. Lets agents remember facts across conversations.★ 4.9 · 5,000+
mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-filesystem
Filesystem
Secure file operations with configurable access controls. Read, write, list, and search local files.★ 4.9 · 5,000+
mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-git
Git
Tools to read, search, and manipulate Git repositories — log, diff, blame, branches, and more.★ 4.9 · 5,000+
mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-fetch
Fetch
Web content fetching and conversion server for efficient LLM usage. Retrieves and converts URLs to clean markdown.★ 4.9 · 5,000+
mcp serverclaude_codecursorcodex
npm install @modelcontextprotocol/server-sequentialthinking
Sequential Thinking
Dynamic problem-solving through structured thought sequences with branching, revision, and reflection.★ 4.9 · 5,000+

Audit before you install

Run any source through our checks - AI visibility, security, performance, and stack detection.

Automated Web Security Scan

security

PageSpeed Analyzer

performance

AI Content Quality Test

arabic content

AI Agent / MCP Server Tester

ai testing

Site Stack Detector

migration

AI SEO / AEO / GEO Audit

ai visibility

llms.txt Generator

ai visibility

Readability Score

arabic content

Schema / JSON-LD Builder

ai visibility

AI Cost Calculator

ai testing

Headline Analyzer

arabic content

More in Development & Code