API versioning with blueprints in Flask

Introduction

API versioning helps keep different versions of your app's features separate. Blueprints let you organize these versions cleanly.

You want to update your API without breaking old apps using it.

You need to support multiple versions of your API at the same time.

You want to keep your code organized by grouping routes by version.

You want to test new features in a new API version before full release.

Syntax

Flask

from flask import Blueprint

v1 = Blueprint('v1', __name__, url_prefix='/api/v1')
v2 = Blueprint('v2', __name__, url_prefix='/api/v2')

@v1.route('/hello')
def hello_v1():
    return 'Hello from API v1'

@v2.route('/hello')
def hello_v2():
    return 'Hello from API v2'

app.register_blueprint(v1)
app.register_blueprint(v2)

Each Blueprint has a url_prefix to separate versions in the URL.

Register each Blueprint with the main Flask app to activate routes.

Examples

This creates a v1 Blueprint with a users route under /api/v1/users.

Flask

v1 = Blueprint('v1', __name__, url_prefix='/api/v1')

@v1.route('/users')
def users_v1():
    return 'Users list from v1'

This creates a v2 Blueprint with a users route under /api/v2/users that can return more data.

Flask

v2 = Blueprint('v2', __name__, url_prefix='/api/v2')

@v2.route('/users')
def users_v2():
    return 'Users list from v2 with extra info'

Sample Program

This Flask app uses two Blueprints to serve two API versions. Visiting /api/v1/hello returns a message from version 1, and /api/v2/hello returns a message from version 2.

Flask

from flask import Flask, Blueprint

app = Flask(__name__)

v1 = Blueprint('v1', __name__, url_prefix='/api/v1')

@v1.route('/hello')
def hello_v1():
    return 'Hello from API v1'

v2 = Blueprint('v2', __name__, url_prefix='/api/v2')

@v2.route('/hello')
def hello_v2():
    return 'Hello from API v2'

app.register_blueprint(v1)
app.register_blueprint(v2)

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

Important Notes

Use clear URL prefixes like /api/v1 to avoid confusion.

Keep your versioned code separate to make updates easier.

Test each version independently to avoid breaking changes.

Summary

API versioning with Blueprints helps organize different API versions cleanly.

Use url_prefix in Blueprints to separate versions in URLs.

Register each version Blueprint with your Flask app to activate routes.

Practice

1. What is the main purpose of using Blueprints for API versioning in Flask?

easy

A. To store user session data securely

B. To speed up the Flask server automatically

C. To organize different API versions with separate URL prefixes

D. To create database models for each API version

Solution

1. Step 1: Understand Blueprints role in Flask

   Blueprints allow grouping routes and related code logically.

2. Step 2: Connect Blueprints to API versioning

   Using url_prefix in Blueprints lets you separate API versions by URL path.

3. Final Answer:

   To organize different API versions with separate URL prefixes -> Option C

4. Quick Check:

   Blueprints + url_prefix = versioned APIs [OK]

Hint: Blueprints + url_prefix separate API versions clearly [OK]

Common Mistakes:

• Thinking Blueprints speed up the server
• Confusing Blueprints with session management
• Assuming Blueprints create database models

2. Which of the following is the correct way to create a Blueprint for API version 1 with prefix '/api/v1'?

easy

A. bp = Blueprint('api_v1', __name__, url_prefix='/api/v1')

B. bp = Blueprint('api_v1', url_prefix='/api/v1')

C. bp = Blueprint(__name__, 'api_v1', url_prefix='/api/v1')

D. bp = Blueprint('api_v1', __name__, prefix='/api/v1')

Solution

1. Step 1: Recall Blueprint constructor parameters

   Blueprint(name, import_name, url_prefix=...)

2. Step 2: Identify correct syntax

   bp = Blueprint('api_v1', __name__, url_prefix='/api/v1') uses correct order and url_prefix keyword.

3. Final Answer:

   bp = Blueprint('api_v1', __name__, url_prefix='/api/v1') -> Option A

4. Quick Check:

   Blueprint(name, __name__, url_prefix=...) correct [OK]

Hint: Blueprint needs name, __name__, and url_prefix keyword [OK]

Common Mistakes:

• Omitting __name__ parameter
• Using 'prefix' instead of 'url_prefix'
• Swapping parameter order incorrectly

3. Given this Flask app code, what URL will return 'Hello from v2!'?

from flask import Flask, Blueprint
app = Flask(__name__)

bp_v1 = Blueprint('v1', __name__, url_prefix='/api/v1')
@bp_v1.route('/hello')
def hello_v1():
    return 'Hello from v1!'

bp_v2 = Blueprint('v2', __name__, url_prefix='/api/v2')
@bp_v2.route('/hello')
def hello_v2():
    return 'Hello from v2!'

app.register_blueprint(bp_v1)
app.register_blueprint(bp_v2)

medium

A. /api/v2/hello

B. /hello

C. /v2/hello

D. /api/v1/hello

Solution

1. Step 1: Check Blueprint url_prefix for v2

   Blueprint 'v2' uses url_prefix='/api/v2'.

2. Step 2: Check route path inside v2 Blueprint

   Route is '/hello', so full path is '/api/v2/hello'.

3. Final Answer:

   /api/v2/hello -> Option A

4. Quick Check:

   Blueprint prefix + route = full URL [OK]

Hint: Combine url_prefix and route path for full URL [OK]

Common Mistakes:

• Ignoring url_prefix and using only route path
• Confusing v1 and v2 prefixes
• Assuming route is registered at root '/'

4. What is wrong with this Flask code for versioned API Blueprints?

bp_v1 = Blueprint('v1', __name__, url_prefix='/api/v1')
@bp_v1.route('/data')
def data_v1():
    return 'Data v1'

app.register_blueprint(bp_v1)

bp_v2 = Blueprint('v2', __name__, url_prefix='/api/v2')
@bp_v1.route('/data')
def data_v2():
    return 'Data v2'

app.register_blueprint(bp_v2)

medium

A. Functions cannot return strings directly

B. Blueprints cannot have the same route path

C. url_prefix should be set on app, not Blueprint

D. The second route decorator uses bp_v1 instead of bp_v2

Solution

1. Step 1: Identify route decorators and Blueprints

   The second route uses @bp_v1.route but should use @bp_v2.route.

2. Step 2: Understand impact of wrong decorator

   This causes the second function to register on the first Blueprint, not the second.

3. Final Answer:

   The second route decorator uses bp_v1 instead of bp_v2 -> Option D

4. Quick Check:

   Route decorator must match Blueprint instance [OK]

Hint: Match route decorator to correct Blueprint instance [OK]

Common Mistakes:

• Using wrong Blueprint for route decorator
• Thinking url_prefix belongs on app
• Believing functions can't return strings

5. You want to add a new API version 3 with a Blueprint and share a common route '/status' that returns different messages per version. Which approach correctly implements this in Flask?

hard

A. Define '/status' route only once on app without Blueprints and check version from headers

B. Create separate Blueprints for v1, v2, v3 each with url_prefix and define '/status' route inside each Blueprint

C. Create one Blueprint with url_prefix='/api' and use if-else inside '/status' route to check version

D. Use Flask extensions to automatically version APIs without Blueprints

Solution

1. Step 1: Understand version separation with Blueprints

   Each API version should have its own Blueprint with distinct url_prefix.

2. Step 2: Define '/status' route separately in each Blueprint

   This allows each version to return its own message cleanly and maintainably.

3. Final Answer:

   Create separate Blueprints for v1, v2, v3 each with url_prefix and define '/status' route inside each Blueprint -> Option B

4. Quick Check:

   Separate Blueprints per version = clean versioning [OK]

Hint: Use separate Blueprints per version for clean route separation [OK]

Common Mistakes:

• Trying to handle versions inside one route with if-else
• Defining routes only once without version separation
• Relying on extensions without understanding Blueprints