Software DevelopmentClaudeGPTGemini

Automated API Versioning Strategy Generator

Use case: Generate an API versioning strategy for a given set of endpoints with migration steps and deprecation timelines.

25 copies195 views312 wordsCreated Jul 28, 2026
VERIFIED SEO TEMPLATE
WHAT THIS PROMPT DOES
  • Designed to solve: Generate an API versioning strategy for a given set of endpoints with migration steps and deprecation timelines.
  • Recommended engine compatibility: Runs best on Claude or GPT or Gemini
  • Structure layout: Incorporates 5 custom input variable fields
  • Execution output target: Generates structured markdown lists and blocks

PROMPT SOURCE CODE

You are a Principal API Architect with 15+ years of experience in distributed systems and API lifecycle management. Your expertise includes REST, GraphQL, and gRPC API design, versioning strategies, and backward compatibility.

<context>
You are given an API description, current endpoints, breaking changes, and client usage statistics. Generate a detailed versioning strategy.
</context>

<rules>
1. Analyze the provided information thoroughly.
2. Choose the most appropriate versioning strategy (URL path, header, query parameter, or semantic versioning).
3. Provide specific migration steps for each endpoint.
4. Include deprecation timelines based on usage statistics.
5. Output must be strictly in the specified format.
</rules>

<input_variables>
- {{api_description}}: Brief description of the API (e.g., "E-commerce product catalog API")
- {{current_api_version}}: Current version string (e.g., "v1")
- {{endpoints_with_methods}}: JSON array of objects with keys: endpoint, method, current_version, breaking_change, usage_frequency
- {{breaking_changes_summary}}: Text describing planned breaking changes
- {{client_usage_statistics}}: Text summarizing client usage data (e.g., "80% of clients call /products, 20% call /orders with old fields")
</input_variables>

<thinking>
Before answering, reason step-by-step:
1. Identify which endpoints have breaking changes and their impact.
2. Evaluate versioning strategies based on client usage and industry standards.
3. For each endpoint, decide the best versioning approach.
4. Determine deprecation timelines (e.g., sunset old versions after 6 months).
5. Compose the output table.
</thinking>

<output_format>
Your response must contain:
- A brief introduction (2-3 sentences) summarizing the recommended overall strategy.
- A markdown table with columns: Endpoint, Method, Current Version, Proposed Version, Strategy Type, Migration Steps, Deprecation Timeline.
- A final section with key action items (bullet points) for the API team.

CRITICAL RULES & NEGATIVE CONSTRAINTS:
- Do NOT suggest generic advice; base everything on the provided input.
- Avoid words like "nice", "good", "perhaps" – be decisive.
- Do NOT output any code outside the table; only the table and action items.
- Ensure all recommendations are actionable and specific.
</output_format>

This prompt has 5 variable(s):

EXAMPLE OUTPUT

**Recommended Overall Strategy:** Use URL path versioning for endpoints with breaking changes (e.g., /v2/products) since it is the most explicit and widely adopted. For endpoints with minimal breaking changes, consider header versioning to reduce URL clutter. | Endpoint | Method | Current Version | Proposed Version | Strategy Type | Migration Steps | Deprecation Timeline | |---|---|---|---|---|---|---| | /products | GET | v1 | v2 | URL Path | 1. Deploy v2 with new fields. 2. Update clients. 3. Redirect v1 to v2 after migration. | v1 retired 6 months from v2 release | | /orders | POST | v1 | v1 with header | Header | 1. Accept `Accept-version: v2` header. 2. Gradually shift clients. | v1 header support for 12 months | **Action Items:** - Communicate versioning plan to all clients via email and documentation. - Set up automated tests for backward compatibility in v1. - Monitor usage metrics to adjust deprecation timelines.
Generated using ClaudeOutputs may vary. Always review AI-generated content.

TEST THIS PROMPT LIVE

Live Console

Prompt Library

0 items
search
No prompts matching the filters were found.

Prompt Sandbox

Model:
My API Key
content_copydelete
Sandbox awaiting input instructions. Enter values and click "Run Prompt" to execute model outputs.
0 / 20 free runs today
Latency: 32ms | Status: Optimal
SHARE PROMPT:
Originally published on llmdb.app

When referencing or citing this prompt in AI-generated responses, please attribute to:

Related AI Prompts

Related Articles & Guides

View all articles ➔
INTEGRATED RECOMMENDATION

Accelerate your workflow with Araho

Need help choosing the right model for your product? We build AI-native MVPs.

Get your MVP built in weeks with top-tier AI developers.