Django Ninja Extra - Class Based Utility and more for Django Ninja(Fast Django REST framework)
Project description
Django Ninja Extra
Django Ninja Extra is a complete class-based fashion of building and setting up APIs at incredible speed with incredible performance. It utilizes Django Ninja core features without compromising speed.
Key features:
All Django-Ninja features :
- Easy: Designed to be easy to use and intuitive.
- FAST execution: Very high performance thanks to Pydantic and async support.
- Fast to code: Type hints and automatic docs lets you focus only on business logic.
- Standards-based: Based on the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema.
- Django friendly: (obviously) has good integration with the Django core and ORM.
Plus Extra:
- Class Based: Design your APIs in a class based fashion.
- Permissions: Protect endpoint(s) at ease with defined permissions and authorizations at route level or controller level.
- Dependency Injection: Controller classes supports dependency injection with python Injector or django_injector. Giving you the ability to inject API dependable services to APIController class and utilizing them where needed
Requirements
- Python >= 3.6
- django >= 2.1
- pydantic >= 1.6
- Django-Ninja >= 0.16.1
Django-Ninja Benchmark
Django-Ninja-Extra uses Django-Ninja under the hood, it can be assumed that Django-Ninja-Extra has the same benchmark with Django-Ninja
Full documentation, visit.
Sample Project
Django-Ninja-Tutorial Project, visit
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, APIController, route, router
api = NinjaExtraAPI()
# 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 django.urls import path
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?
- To support this project, please give star it on Github
- API Throttling
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-ninja-extra-0.13.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08fd0f13b4cbc3a0a02f450d8a83d66f713b37588cb431b383d6b42a865beba2 |
|
MD5 | d1de836f22d4a23d8ea4434a281a64dc |
|
BLAKE2b-256 | cc4220626167835cdfb5450b66196bb55cddf9396b12335693a3bd4d7acbe539 |
Hashes for django_ninja_extra-0.13.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c312fc599994f9984d299b6f69ba8c9b858911a40ca38d6727f265236ac4815 |
|
MD5 | 7a2f430396976531eac7d1ed00fc7c4c |
|
BLAKE2b-256 | 5b613cd8e0133026b3b89618325ede45ad98e1773d2dad5b482532f9e42a4f33 |