Index of every page on this site: llms.txt
All skills
Run it yourself

Implement API migrations between versions, platforms, or frameworks with minimal downtime. Use when upgrading APIs between versions. Trigger with phrases like "migrate the API", "upgrade API version", or "migrate to new API".

Use this Skill: https://skilld.dev/gh/jeremylongshore/tons-of-skills-marketplace/migrating-apis

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈60 tokens for metadata: the name and description. ≈1.3k when used: this file. ≈1.9k more on demand in 3 files.

Description uses 3.0% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈242 characters, or 3.0%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Migrating APIs

Overview

Implement API migrations between versions, frameworks, or platforms with minimal downtime using strangler fig pattern, parallel running, and traffic shadowing. Generate migration plans that map old endpoints to new equivalents, transform request/response formats, and validate data consistency between legacy and target implementations.

Prerequisites

  • Source API codebase and OpenAPI specification accessible for analysis
  • Target framework or platform environment provisioned and accessible
  • Traffic routing capability for gradual cutover (reverse proxy, feature flags, or API gateway)
  • Database migration tools if schema changes accompany the API migration (Flyway, Alembic, Prisma Migrate)
  • Integration test suite covering all existing API consumers

Instructions

  1. Inventory all existing endpoints using Grep and Read, documenting HTTP methods, URL patterns, request/response schemas, authentication mechanisms, and consumer dependencies.
  2. Generate an endpoint mapping table that pairs each legacy endpoint with its target equivalent, flagging breaking changes in URL structure, field names, data types, and authentication flow.
  3. Create request/response adapters that transform legacy format to target format, handling field renames, nested-to-flat conversions, and enum value changes.
  4. Implement a traffic router (reverse proxy rules or middleware) that directs requests to either the legacy or target implementation based on migration phase, endpoint, or feature flag.
  5. Set up traffic shadowing to duplicate production requests to the target implementation without serving target responses, comparing outputs for data consistency validation.
  6. Build a migration dashboard tracking per-endpoint migration status (legacy-only, shadow, canary, migrated), error rates, and latency comparison between implementations.
  7. Execute phased cutover: shadow (compare only) -> canary (1% traffic to target) -> gradual ramp (10%, 25%, 50%, 100%) -> legacy decommission, with automatic rollback triggers.
  8. Validate migration completeness by running the full integration test suite against the target implementation and comparing response bodies with legacy for a representative request sample.

See references/implementation.md for the full implementation guide.

Output

  • ${CLAUDE_SKILL_DIR}/migration/endpoint-mapping.json - Legacy-to-target endpoint mapping with change annotations
  • ${CLAUDE_SKILL_DIR}/migration/adapters/ - Request/response transformation functions per endpoint
  • ${CLAUDE_SKILL_DIR}/migration/router.js - Traffic routing middleware with phase-based switching
  • ${CLAUDE_SKILL_DIR}/migration/shadow-compare.js - Traffic shadow comparison and diff reporting
  • ${CLAUDE_SKILL_DIR}/migration/dashboard.md - Migration progress tracking per endpoint
  • ${CLAUDE_SKILL_DIR}/tests/migration/ - Parity tests comparing legacy and target responses

Error Handling

Error Cause Solution
Response mismatch in shadow Target returns different data than legacy for same request Log diff details; classify as expected (intentional change) or bug; fix before canary phase
Adapter transformation failure Legacy request contains edge-case field values not handled by adapter Add fallback handling; log unmatched fields; expand adapter test coverage
Rollback triggered Canary error rate exceeds threshold (e.g., >2% 5xx) Automatically route traffic back to legacy; alert migration team; analyze failures
Consumer authentication break Target uses different auth scheme than legacy Run auth adapter translating legacy tokens to target format during transition
Data inconsistency Database schema migration introduced transformation errors Run data validation queries comparing legacy and target data stores; fix transformation logic

Refer to references/errors.md for comprehensive error patterns.

Examples

Express to FastAPI migration: Migrate a Node.js Express API to Python FastAPI, using nginx as the traffic router, shadowing production traffic for 1 week, then canary-releasing endpoint by endpoint over 4 weeks.

REST to GraphQL migration: Implement GraphQL resolvers that call the existing REST endpoints internally, gradually replacing REST data fetching with direct database access while maintaining the REST surface via a thin GraphQL-to-REST adapter.

Monolith to microservices: Extract a user management module from a monolithic API into a standalone service, using the strangler fig pattern with API gateway routing to direct /users/* traffic to the new service while other endpoints remain on the monolith.

See references/examples.md for additional examples.

Resources

  • Strangler Fig Application pattern: Martin Fowler
  • Feature flag services: LaunchDarkly, Unleash, Flagsmith
  • Traffic shadowing with Envoy proxy or Istio service mesh
  • Blue-green and canary deployment strategies

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts2mo3 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    The skill is designed to assist in API migrations by analyzing existing codebases and generating transformation logic. It presents a low-risk surface for indirect prompt injection as it ingests and processes potentially untrusted external source code and API specifications.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

Signed by skilld at 820dfc8. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 20 hours ago.

Activeupdated last month
What it can do
Reads files Edits files Runs commands
version
1.26.0
author
Jeremy Longshore <jeremy@intentsolutions.io>
tags
[
  "api",
  "migration",
  "migrating-apis"
]
All 6 allowed tools
ReadWriteEditGrepGlobBash(api:migrate-*)
Other metadata
compatibility
Designed for Claude Code

README badge

README badge for jeremylongshore/tons-of-skills-marketplace/migrating-apis