API versioning strategies in Express

Introduction

API versioning helps keep your app working well when you add new features or change things. It lets old and new users use the API without problems.

You want to add new features without breaking old apps using your API.

You need to fix bugs or improve your API but keep old versions working.

You want to support different clients that need different API versions.

You plan to change how your API works but want to avoid sudden breaks.

You want to organize your API routes clearly by version.

Syntax

Express

const express = require('express');
const app = express();

// Example: Versioning using URL path
app.get('/v1/resource', (req, res) => {
  res.send('Response from version 1');
});

app.get('/v2/resource', (req, res) => {
  res.send('Response from version 2');
});

Versioning can be done in different ways like URL path, headers, or query parameters.

URL path versioning is simple and easy to test in browsers.

Examples

This uses the URL path to separate versions, like /v1/ and /v2/.

Express

// URL path versioning
app.get('/v1/users', (req, res) => {
  res.send('Users from v1');
});

app.get('/v2/users', (req, res) => {
  res.send('Users from v2');
});

This checks a custom header to decide which version to use.

Express

// Header versioning
app.get('/users', (req, res) => {
  const version = req.headers['accept-version'];
  if (version === '2') {
    res.send('Users from v2');
  } else {
    res.send('Users from v1');
  }
});

This uses a query like ?version=2 to select the API version.

Express

// Query parameter versioning
app.get('/users', (req, res) => {
  const version = req.query.version;
  if (version === '2') {
    res.send('Users from v2');
  } else {
    res.send('Users from v1');
  }
});

Sample Program

This example shows two versions of a greeting API using URL path versioning. You can visit /v1/greet or /v2/greet to see different responses.

Express

const express = require('express');
const app = express();
const port = 3000;

// Version 1 route
app.get('/v1/greet', (req, res) => {
  res.send('Hello from API version 1');
});

// Version 2 route
app.get('/v2/greet', (req, res) => {
  res.send('Hello from API version 2 with new features');
});

app.listen(port, () => {
  console.log(`Server running on http://localhost:${port}`);
});

Important Notes

URL path versioning is easiest to implement and test but can clutter URLs.

Header versioning keeps URLs clean but needs clients to set headers correctly.

Always document your versioning method clearly for users.

Summary

API versioning helps keep old and new API users happy.

Common ways: URL path, headers, or query parameters.

Choose the method that fits your app and users best.

Practice

1. Which of the following is a common method to implement API versioning in Express?

easy

A. Using the URL path to specify the version, like /v1/users

B. Changing the database schema for each version

C. Using different port numbers for each API version

D. Renaming the Express app for each version

Solution

1. Step 1: Understand common API versioning methods

   API versioning often uses the URL path, headers, or query parameters to distinguish versions.

2. Step 2: Identify the correct method in Express

   Using the URL path like /v1/users is a standard and clear way to version APIs in Express.

3. Final Answer:

   Using the URL path to specify the version, like /v1/users -> Option A

4. Quick Check:

   URL path versioning = Using the URL path to specify the version, like /v1/users [OK]

Hint: API versions often appear in the URL path [OK]

Common Mistakes:

• Thinking database changes are API versioning
• Using different ports instead of URL or headers
• Renaming the app does not affect API versioning

2. Which Express code snippet correctly sets up API versioning using URL path?

easy

A. app.get('v1/users', userRouter);

B. app.use('/v1/users', userRouter);

C. app.route('/users/v1').get(userRouter);

D. app.listen('/v1/users', userRouter);

Solution

1. Step 1: Review Express routing syntax

   Express uses app.use(path, router) to mount routers on paths.

2. Step 2: Identify correct versioning path usage

   Using app.use('/v1/users', userRouter); correctly mounts the router for version 1 users.

3. Final Answer:

   app.use('/v1/users', userRouter); -> Option B

4. Quick Check:

   Correct Express routing = app.use('/v1/users', userRouter); [OK]

Hint: Use app.use with path and router for versioning [OK]

Common Mistakes:

• Missing leading slash in path
• Using app.get instead of app.use for routers
• Incorrect method like app.listen for routing

3. Given this Express code, what is the response when a client requests /api/users?

const express = require('express');
const app = express();

app.use('/api/v1/users', (req, res) => res.send('Version 1 users'));
app.use('/api/v2/users', (req, res) => res.send('Version 2 users'));

app.listen(3000);

medium

A. Cannot GET /api/users

B. Version 2 users

C. Version 1 users

D. Server error

Solution

1. Step 1: Check defined routes

   Routes are defined only for /api/v1/users and /api/v2/users.

2. Step 2: Analyze request path

   The request is for /api/users, which does not match any defined route.

3. Final Answer:

   Cannot GET /api/users -> Option A

4. Quick Check:

   Undefined route returns 404 = Cannot GET /api/users [OK]

Hint: Check exact route paths before guessing response [OK]

Common Mistakes:

• Assuming /api/users matches /api/v1/users
• Expecting default route without defining it
• Confusing middleware with route handlers

4. Identify the error in this Express API versioning code:

const express = require('express');
const app = express();

app.use('/v1/users', userRouter);
app.use('/v2/users', userRouter);

app.listen(3000);

Assuming userRouter handles all user routes.

medium

A. Both versions use the same router instance, causing version conflicts

B. Missing const before userRouter

C. Routes should use app.get instead of app.use

D. No error; this is a valid versioning setup

Solution

1. Step 1: Understand router reuse in Express

   Using the same router instance for different paths is valid and common in Express.

2. Step 2: Check for syntax and method correctness

   Using app.use to mount routers on different paths is correct; no syntax errors present.

3. Final Answer:

   No error; this is a valid versioning setup -> Option D

4. Quick Check:

   Router reuse with different paths is valid = No error; this is a valid versioning setup [OK]

Hint: Reusing routers for versions is allowed in Express [OK]

Common Mistakes:

• Thinking router reuse causes conflicts
• Confusing app.use with app.get for routers
• Expecting separate router instances per version

5. You want to support API versioning in Express using request headers instead of URL paths. Which code snippet correctly reads the version from the header X-API-Version and routes accordingly?

hard

A. app.use('/v1/users', userRouter);
app.use('/v2/users', userV2Router);

B. app.use('/users', (req, res) => {
const version = req.query.version;
if (version === '1') userRouter(req, res);
else userV2Router(req, res);
});

C. app.use((req, res, next) => {
const version = req.headers['x-api-version'];
if (version === '1') userRouter(req, res, next);
else if (version === '2') userV2Router(req, res, next);
else res.status(400).send('Invalid API version');
});

D. app.get('/users', (req, res) => {
const version = req.headers['api-version'];
if (version === '1') res.send('User v1');
else res.send('User v2');
});

Solution

1. Step 1: Identify header-based versioning approach

   Version is read from X-API-Version header in the request.

2. Step 2: Check routing logic based on header

   app.use((req, res, next) => { const version = req.headers['x-api-version']; if (version === '1') userRouter(req, res, next); else if (version === '2') userV2Router(req, res, next); else res.status(400).send('Invalid API version'); }); reads the header, then calls the correct router or returns error if invalid.

3. Final Answer:

   app.use((req, res, next) => { const version = req.headers['x-api-version']; if (version === '1') userRouter(req, res, next); else if (version === '2') userV2Router(req, res, next); else res.status(400).send('Invalid API version'); }); -> Option C

4. Quick Check:

   Header-based routing = app.use((req, res, next) => { const version = req.headers['x-api-version']; if (version === '1') userRouter(req, res, next); else if (version === '2') userV2Router(req, res, next); else res.status(400).send('Invalid API version'); }); [OK]

Hint: Use middleware to check headers and route accordingly [OK]

Common Mistakes:

• Using query parameters instead of headers
• Not calling next() or router properly
• Checking wrong header name