The Best Way to Implement API Versioning in Django REST Framework (Agile) 💎

Suliman Awad — Mon, 09 Sep 2024 11:09:06 +0000

API versioning is one of the most important topics in backend development. It ensures that live applications continue running smoothly even when changes are made to the APIs, preventing any downtime or disruptions.

In this article, we’ll explore how to implement API versioning in Django REST Framework in the best and simplest way.

API Versioning in the URL:

Even if your project is already live and running on production servers, this method ensures backward compatibility. It allows for the version to be optional in the URL, defaulting to version 1 if no version is specified.

To implement API versioning, we need to make three key changes to our project:

Create a custom versioning class.
Set the custom versioning class as the default in the project settings.
Allow an optional version in the URL prefix for the entire project.

Creating the Versioning Class:

First, create the following file in your project: Project/common/rest_framework/api_versioning.py

from rest_framework import versioning

class CustomURLPathVersioning(versioning.URLPathVersioning):
    default_version = 1
    version_param = 'version'

VERSION = r'v(?P<version>\d+)/'
OPTIONAL_VERSION = r'(v(?P<version>\d+)/)?'

Setting the Versioning Class as the Default:

Next, set the versioning class as the default in your settings.py file:

# Project/settings.py

REST_FRAMEWORK = {
    # Other REST framework settings...

    'DEFAULT_VERSIONING_CLASS': 'common.rest_framework.api_versioning.CustomURLPathVersioning',
}

Accepting the Optional Version in the URL Prefix:

Now, modify your urls.py file to allow an optional version in the URL:

# Project/urls.py
from django.urls import path, re_path, include
from common.rest_framework.api_versioning import OPTIONAL_VERSION

app_patterns = [
    path('app1/', include('app1.urls')),
    path('app2/', include('app2.urls')),
]

urlpatterns = [
    # Other URL patterns...
    re_path(rf'^api/{OPTIONAL_VERSION}', include(app_patterns)),
]

If your project is already using path in the URL definitions, you’ll need to replace it with re_path and add the {OPTIONAL_VERSION} prefix to all your API URLs.

Usage:

Now that versioning is in place, you can access the version in your views using the request.version property. You can then handle your versioning logic based on this property. A common and clear approach is to return a specific serializer for each version.

Example:

class TestAPIView(APIView):
    def get_serializer_class(self):
        if self.request.version == 2:
            return TestSerializerV2
        return TestSerializer

In this example:

If the URL is called without a version (/api/endpoint or /api/v1/endpoint), the default version (1) will be used, returning the original serializer (TestSerializer).
If the URL includes version 2 (/api/v2/endpoint), the version will be considered 2, and the new serializer (TestSerializerV2) will be returned.

Conclusion:

With this setup, you can easily implement API versioning in Django REST Framework without disrupting existing functionality or causing issues for live applications. This method ensures flexibility, stability, and smooth transitions as you evolve your API.

Happy coding, and may your projects continue to run stably with proper API versioning! 😊

Automate Data Seeding in Django with django-seeding: A Developer's Delight 🔥

Suliman Awad — Sat, 28 Oct 2023 22:27:31 +0000

When building web applications, it's common to spend a significant amount of time 🧭 populating the database with needed data. Whether it's for development, testing, or demonstrations, having a streamlined way to fill your database can significantly boost productivity. That's where django-seeding comes into play ⭐.

The Challenge of Data Seeding 🚨

Picture this: You're developing a Django application, and you need to test how your system behaves with a large dataset. Manually creating thousands of records in the Django admin panel or through custom scripts can be tedious and time-consuming. What if there was a more efficient way to get this job done?

Introducing django-seeding 💎

django-seeding is a Python package that empowers Django developers to automate the process of filling their databases with data. Whether you need data for testing, development, or simply to demonstrate your application, this package simplifies the task by introducing the ability to seed the data from CSV files or JSON files.
The best part? It's incredibly easy to use.

Seeding Made Simple ✨

with django-seeing, you can create data definitions in a matter of minutes. A data definition is a CSV file, JSON file, or a Python dictionary that represents your data. Here's a basic example:

from django_seeding import seeders
from django_seeding.seeder_registry import SeederRegistry
from django_seeding_example.models import M1

@SeederRegistry.register
class M1Seeder(seeders.CSVFileModelSeeder):
  model = M1
  csv_file_path = 'django_seeding_example/seeders_data/M1Seeder.csv'

In this example, we're seeding a M1 model with the data from the CSV file specified.

From CSVs to Data 👌

django-seeding offers versatility. Not only can you define your data directly in your code, but you can also import data from CSV or JSON files. This means that you can prepare your data externally and then feed it into your Django application with ease.

Boosting Developer Productivity 💰

This package is a developer's delight. By automating data seeding, you can focus more on building features and less on tedious tasks. You'll find that development, testing, and debugging become smoother and more efficient.

Simplicity and Integration 😃

django-seeding is designed to be straightforward to use. It integrates seamlessly with Django models and the Django ORM, making it a natural fit for Django projects. There's no need to learn a complex new system; it complements the Django environment you're already familiar with.

Enhance Your Workflow 🙌

As a Django developer, you're constantly striving to enhance your workflow. django-seeding is a valuable tool for streamlining your development process. Whether you're testing a new feature or just need to demonstrate your app to a client, having a reliable way to populate your database can make a world of difference.
Get Started with django-seeding
Ready to give django-seeding a try? You can install it via pip:

pip install django-seeding

And then check out the comprehensive documentation to explore the various possibilities: https://pypi.org/project/django-seeding/
Don't spend unnecessary time and effort manually creating test data for your Django application. Automate the process and see how django-seeding can elevate your development game.
Happy seeding! 🎁

DEV Community: Suliman Awad