Version an API with URL Path Segments
Mount v1 and v2 on separate path prefixes so a breaking change in v2 does not affect v1 clients still in production.
Task
Implement app.use('/v1', v1Router); app.use('/v2', v2Router); so the service degrades gracefully under failure instead of cascading timeouts to callers.
When to use this
A downstream service slows down and without app.use('/v1', v1Router); app.use('/v2', v2Router); the upstream exhausts its thread pool in 12 seconds.
Prerequisites
- A service with inter-service calls or external dependencies
- A retry or circuit breaker library available
Steps
1. Configure app.use('/v1', v1Router); app.use('/v2', v2Router); in the project configuration file with the recommended defaults.
app.use('/v1', v1Router); app.use('/v2', v2Router);
Expected output: The configuration is accepted and app.use('/v1', v1Router); app.use('/v2', v2Router); runs without errors on the first invocation.
2. Run the check locally to verify app.use('/v1', v1Router); app.use('/v2', v2Router); produces the expected result before pushing.
pnpm test
Expected output: Local run matches CI behavior; no surprises after push.
3. Add the gate to the CI pipeline so app.use('/v1', v1Router); app.use('/v2', v2Router); blocks merge on failure.
- name: Run add api versioning url path
run: pnpm test
Expected output: Pull requests with failing app.use('/v1', v1Router); app.use('/v2', v2Router); are blocked from merging.
Troubleshooting
Problem
The check passes locally but fails in CI
Solution
Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.
Problem
Configuration is rejected with a schema error
Solution
Check the tool version matches the config schema; older versions may not support newer fields.
Limitations
- The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
- Configuration drift is possible if someone edits settings outside version control.
Isolate failure
Start by measuring the problem. Mount v1 and v2 on separate path prefixes so a breaking change in v2 does not affect v1 clients still in production. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run app.use(‘/v1’, v1Router); app.use(‘/v2’, v2Router); against the current codebase and inspect the output before wiring it into CI.
app.use('/v1', v1Router); app.use('/v2', v2Router);Verify graceful degradation
Once the gate is in place, make failures actionable. A failing app.use(‘/v1’, v1Router); app.use(‘/v2’, v2Router); should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.