django-ninja-extra 0.11.0

Django Ninja Extra - Class Based Utility and more for Django Ninja(Fast Django REST framework)

Django Ninja Extra

Django Ninja Extra is a utility library built on top of Django Ninja for building and setting up APIs at incredible speed and performance. It adds DRF batteries to Django Ninja which are really extensible for custom use-cases.

Key features: All Django-Ninja features are fully supported plus others below:

• Class Based: Design your APIs in a class based fashion.
• Route Permissions: Protect endpoint(s) at ease, specific or general
• Dependency Injection: Controller classes supports dependency injection with python Injector or django_injector

---

Installation

pip install django-ninja-extra

After installation, add ninja_extra to your INSTALLED_APPS

INSTALLED_APPS = [
    ...,
    'ninja_extra',
]

Usage

In your django project next to urls.py create new api.py file:

from ninja_extra import NinjaExtraAPI
from ninja_extra import APIController, route, router
from ninja_extra.permissions import AllowAny
from ninja_extra.shortcuts import get_object_or_404
from django.contrib.auth import get_user_model
from .models import UserProfile

api = NinjaExtraAPI()
user_model = get_user_model()

# function based definition
@api.get("/add", tags=['Math'])
def add(request, a: int, b: int):
    return {"result": a + b}

#class based definition
@router('/', tags=['Math'], permissions=[])
class MathAPI(APIController):

    @route.get('/subtract',)
    def subtract(self, a: int, b: int):
        """Subtracts a from b"""
        return {"result": a - b}

    @route.get('/divide',)
    def divide(self, a: int, b: int):
        """Divides a by b"""
        return {"result": a / b}
    
    @route.get('/multiple',)
    def multiple(self, a: int, b: int):
        """Multiples a with b"""
        return {"result": a * b}
    
api.register_controllers(
    MathAPI
)

Now go to urls.py and add the following:

...
from .api import api

urlpatterns = [
    path("admin/", admin.site.urls),
    path("api/", api.urls),  # <---------- !
]

Interactive API docs

Now go to http://127.0.0.1:8000/api/docs

You will see the automatic interactive API documentation (provided by Swagger UI):

What next?

• Full documentation here - Still in progress
• To support this project, please give star it on Github