Django Ninja Extra
Django Ninja Extra is a powerful extension for Django Ninja that enhances your Django REST API development experience. It introduces class-based views and advanced features while maintaining the high performance and simplicity of Django Ninja. Whether you're building a small API or a large-scale application, Django Ninja Extra provides the tools you need for clean, maintainable, and efficient API development.
Features
Core Features (Inherited from Django Ninja)
- ⚡ High Performance: Built on Pydantic for lightning-fast validation
- 🔄 Async Support: First-class support for async/await operations
- 📝 Type Safety: Comprehensive type hints for better development experience
- 🎯 Django Integration: Seamless integration with Django's ecosystem
- 📚 OpenAPI Support: Automatic API documentation with Swagger/ReDoc
- 🔒 API Throttling: Rate limiting for your API
Extra Features
-
🏗️ Class-Based Controllers:
- Organize related endpoints in controller classes
- Inherit common functionality
- Share dependencies across endpoints
-
🔒 Advanced Permission System (Similar to Django Rest Framework):
- Controller-level permissions
- Route-level permission overrides
- Custom permission classes
-
💉 Dependency Injection:
- Built-in support for Injector
- Compatible with django_injector
- Automatic dependency resolution
-
🔧 Service Layer:
- Injectable services for business logic
- Better separation of concerns
- Reusable components
Requirements
- Python >= 3.6
- Django >= 2.1
- Pydantic >= 1.6
- Django-Ninja >= 0.16.1
Installation
- Install the package:
pip install django-ninja-extra
- Add to INSTALLED_APPS:
INSTALLED_APPS = [
...,
'ninja_extra',
]
Quick Start Guide
1. Basic API Setup
Create api.py in your Django project:
from ninja_extra import NinjaExtraAPI, api_controller, http_get
api = NinjaExtraAPI()
# Function-based endpoint example
@api.get("/hello", tags=['Basic'])
def hello(request, name: str = "World"):
return {"message": f"Hello, {name}!"}
# Class-based controller example
@api_controller('/math', tags=['Math'])
class MathController:
@http_get('/add')
def add(self, a: int, b: int):
"""Add two numbers"""
return {"result": a + b}
@http_get('/multiply')
def multiply(self, a: int, b: int):
"""Multiply two numbers"""
return {"result": a * b}
# Register your controllers
api.register_controllers(MathController)
2. URL Configuration
In urls.py:
from django.urls import path
from .api import api
urlpatterns = [
path("api/", api.urls), # This will mount your API at /api/
]
Advanced Features
Authentication and Permissions
from ninja_extra import api_controller, http_get
from ninja_extra.permissions import IsAuthenticated, PermissionBase
# Custom permission
class IsAdmin(PermissionBase):
def has_permission(self, context):
return context.request.user.is_staff
@api_controller('/admin', tags=['Admin'], permissions=[IsAuthenticated, IsAdmin])
class AdminController:
@http_get('/stats')
def get_stats(self):
return {"status": "admin only data"}
@http_get('/public', permissions=[]) # Override to make public
def public_stats(self):
return {"status": "public data"}
Dependency Injection with Services
from injector import inject
from ninja_extra import api_controller, http_get
# Service class
class UserService:
def get_user_details(self, user_id: int):
return {"user_id": user_id, "status": "active"}
# Controller with dependency injection
@api_controller('/users', tags=['Users'])
class UserController:
def __init__(self, user_service: UserService):
self.user_service = user_service
@http_get('/{user_id}')
def get_user(self, user_id: int):
return self.user_service.get_user_details(user_id)
API Documentation
Access your API's interactive documentation at /api/docs:
Learning Resources
Tutorials
Community and Support
Contributing
We welcome contributions! Here's how you can help:
- Fork the repository
- Create a feature branch
- Write your changes
- Submit a pull request
Please ensure your code follows our coding standards and includes appropriate tests.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Support the Project
- ⭐ Star the repository
- 🐛 Report issues
- 📖 Contribute to documentation
- 🤝 Submit pull requests
DEPRECATION NOTICE
0.22.2
The service attribute in ModelController has been changed from a class object to an instance object. When creating a custom ModelService for a ModelController, you have to specify it as service_type.
This is because services are now injected as dependencies during controller instantiation. Service instantiation is delegated to the injector package, so ensure that any additional dependencies required by your ModelService are properly registered in the dependency injection container.
For more details, please refer to the documentation
1 maintainer
Metadata
1 maintainer
Release files for django-ninja-extra 0.31.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| django_ninja_extra-0.31.7.tar.gz | 62.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_ninja_extra-0.31.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 147.0 kB
Release files / django_ninja_extra-0.31.7.tar.gz
| Download URL | django_ninja_extra-0.31.7.tar.gz |
|---|---|
| Size | 62.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ad3ab759ed839456ee15bc07c201f2b7fc2ceaedc0fac43841482922c2621dca
|
|
BLAKE2b-256 checksum How to use checksums |
f7a1922e1b1ef33f505133971e15d28c46af4feb8ef36ce0d456690c42b803f0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / django_ninja_extra-0.31.7-py3-none-any.whl
| Download URL | django_ninja_extra-0.31.7-py3-none-any.whl |
|---|---|
| Size | 84.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f6e980d9173b3551a3c9a18ce6fea9314c6b2cc6a2e97b48f4ac155a9bcef91a
|
|
BLAKE2b-256 checksum How to use checksums |
8a769eff89eecd25c7ccbc5b4e840cd248fb31cdbeca8dad5007be6bcc1976fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for django-ninja-extra 0.31.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
