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:
- Class Based: Design your APIs in a class based fashion.
- Async Model Fetch Support: Supports Django's ORM current async solution
- Route Permissions: Protect endpoint(s) at ease, specific or general
- Route Pagination: Paginate route(s) with ease
Installation
pip install django-ninja-extra
or
pip install git+https://github.com/eadwinCode/django-ninja-extra.git
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
from ninja_extra.permissions import AllowAny
from ninja_extra.shortcuts import get_object_or_404
from django.contrib.auth import get_user_model
api = NinjaExtraAPI()
user_model = get_user_model()
@api.get("/add")
def add(request, a: int, b: int):
return {"result": a + b}
class UserController(APIController):
prefix: '/users'
@route.get('/{user_id}', response=UserSchema, permissions=[AllowAny])
def get_user(self, context, user_id: int):
"""get user by id"""
user = get_object_or_404(user_model, pk=user_id)
response_object = UserSchema.from_django(user)
return response_object
@route.retrieve(
'/{user_id}/profile',
response=UserProfileSchema,
permissions=[AllowAny],
query_set=UserProfile.objects.all(),
lookup_url_kwarg='user_id',
lookup_field='user'
)
def get_user_profile(self, context, user_id: int):
"""gets a user's profile by user id"""
return context.object
api.register_controllers(
UserController,
NewsController
)
Now go to urls.py and add the following:
...
from .api import api
urlpatterns = [
path("admin/", admin.site.urls),
path("api/", api.urls), # <---------- !
]
That's it !
Now you've just created an API that:
- receives an HTTP GET request at
/api/add - takes, validates and type-casts GET parameters
aandb - decodes the result to JSON
- generates an OpenAPI schema for defined operation
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
- Permission feature is not fully ready
- Unit Test is in progress
1 maintainer
Release files for django-ninja-extra 0.10.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django-ninja-extra-0.10.1.tar.gz | 23.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_ninja_extra-0.10.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 46.9 kB
Release files / django-ninja-extra-0.10.1.tar.gz
| Download URL | django-ninja-extra-0.10.1.tar.gz |
|---|---|
| Size | 23.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f1ce18295e23f35cf6782de32ed57834e41d1be12e5ad8434e8d876d978b2cbc
|
|
BLAKE2b-256 checksum How to use checksums |
091ef58584ab2064631553655eec57db79dab4362fa53e16895a7a17c563118c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.23.0
|
Release files / django_ninja_extra-0.10.1-py3-none-any.whl
| Download URL | django_ninja_extra-0.10.1-py3-none-any.whl |
|---|---|
| Size | 23.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
76be8b4eb530d4c9af59ec3aa7f536400373e920c25c5027d82a15711ab12fa4
|
|
BLAKE2b-256 checksum How to use checksums |
4504a9e76664e3cac8b84f762cebe5ff165372495052e5c3f778e16826a67ba3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.23.0
|
