Versioning best practices in Rest API

Introduction

Versioning helps keep your API working well for everyone, even when you make changes. It stops old apps from breaking when you add new features.

You want to add new features without breaking old apps.

You need to fix bugs but keep old behavior for existing users.

You want to support different clients using different API versions.

You plan to improve your API over time safely.

You want to communicate changes clearly to developers.

Syntax

Rest API

GET /api/v1/resource
GET /api/v2/resource

or

GET /api/resource?v=1
GET /api/resource?v=2

or

Accept: application/vnd.example.v1+json
Accept: application/vnd.example.v2+json

Version can be in the URL path, query parameter, or HTTP header.

Choose one method and keep it consistent for your API.

Examples

Version in the URL path is easy to see and use.

Rest API

GET /api/v1/users
GET /api/v2/users

Version as a query parameter keeps URLs clean but requires clients to add the parameter.

Rest API

GET /api/users?v=1
GET /api/users?v=2

Version in the HTTP header keeps URLs clean and allows content negotiation.

Rest API

Accept: application/vnd.example.v1+json
Accept: application/vnd.example.v2+json

Sample Program

This simple Flask app shows two API versions with different messages. Clients can choose which version to call by changing the URL.

Rest API

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/api/v1/greet')
def greet_v1():
    return jsonify({'message': 'Hello from version 1!'})

@app.route('/api/v2/greet')
def greet_v2():
    return jsonify({'message': 'Hello from version 2 with new features!'})

if __name__ == '__main__':
    app.run(debug=True)

Important Notes

Keep old versions working as long as needed to avoid breaking users.

Document each version clearly so developers know what changed.

Use semantic versioning (major.minor) to signal big or small changes.

Summary

Version your API to keep it stable and safe for users.

Use URL path, query, or headers for versioning, but be consistent.

Maintain and document versions to help developers use your API well.

Practice

1. What is the main reason to use versioning in a REST API?

easy

A. To hide the API from users

B. To make the API faster

C. To reduce the number of API endpoints

D. To keep the API stable and avoid breaking existing clients

Solution

1. Step 1: Understand API stability

   Versioning helps keep the API stable by allowing changes without breaking existing users.

2. Step 2: Identify the main goal of versioning

   The main goal is to avoid breaking existing clients when the API changes.

3. Final Answer:

   To keep the API stable and avoid breaking existing clients -> Option D

4. Quick Check:

   Versioning = Stability [OK]

Hint: Versioning protects old users from breaking changes [OK]

Common Mistakes:

• Thinking versioning makes API faster
• Believing versioning reduces endpoints
• Assuming versioning hides the API

2. Which of the following is a correct way to include versioning in a REST API URL?

easy

A. /api/v1/users

B. /api/users/v1

C. /v1/api/users

D. /users/api/v1

Solution

1. Step 1: Identify common versioning URL pattern

   The standard practice is to put the version right after the base API path, like /api/v1/.

2. Step 2: Check each option

   Only /api/v1/users follows the common pattern where version is after /api/.

3. Final Answer:

   /api/v1/users -> Option A

4. Quick Check:

   Version in URL path = /api/v1/ [OK]

Hint: Version usually goes right after /api/ in URL [OK]

Common Mistakes:

• Placing version after resource name
• Putting version before /api/
• Adding version at the end of URL

3. Given this API request header: Accept: application/vnd.example.v2+json, what version of the API is being requested?

medium

A. Version 3

B. Version 1

C. Version 2

D. No version specified

Solution

1. Step 1: Analyze the Accept header format

   The header uses media type versioning with 'v2' indicating version 2.

2. Step 2: Identify the version number

   The 'v2' in 'application/vnd.example.v2+json' means version 2 is requested.

3. Final Answer:

   Version 2 -> Option C

4. Quick Check:

   Header v2 means API version 2 [OK]

Hint: Look for 'v' followed by number in Accept header [OK]

Common Mistakes:

• Ignoring 'v2' and assuming version 1
• Confusing media type with version
• Assuming no version if not in URL

4. You have an API that uses URL versioning like /api/v1/resource. You want to upgrade to version 2 but keep version 1 working. What is the best fix if your current code overwrites the version path and breaks v1?

medium

A. Create separate routes for /api/v1/resource and /api/v2/resource

B. Remove version from URL and use query parameters instead

C. Only keep /api/v2/resource and delete /api/v1/resource

D. Use the same code for both versions without changes

Solution

1. Step 1: Understand versioning goal

   Versioning allows multiple versions to coexist so old clients keep working.

2. Step 2: Fix route handling

   Separate routes for each version keep both versions working without conflict.

3. Final Answer:

   Create separate routes for /api/v1/resource and /api/v2/resource -> Option A

4. Quick Check:

   Separate routes = keep versions working [OK]

Hint: Keep old and new versions on separate routes [OK]

Common Mistakes:

• Overwriting old version routes
• Removing version info completely
• Using same code for different versions

5. You want to design an API versioning strategy that allows clients to specify the version either in the URL path or in a custom header. Which approach best follows versioning best practices?

hard

A. Ignore versioning and always use the latest API version

B. Support both methods but clearly document and prefer one as primary

C. Allow clients to mix URL and header versions freely without restrictions

D. Use query parameters for versioning only

Solution

1. Step 1: Understand consistency in versioning

   Best practice is to be consistent and clear about versioning methods.

2. Step 2: Choose a primary versioning method

   Supporting both but preferring one and documenting it helps developers avoid confusion.

3. Final Answer:

   Support both methods but clearly document and prefer one as primary -> Option B

4. Quick Check:

   Clear, consistent versioning = best practice [OK]

Hint: Pick one versioning method as main, document it well [OK]

Common Mistakes:

• Mixing versions without clear rules
• Ignoring versioning and breaking clients
• Using only query parameters without reason