Django Ninja Extra - Class Based Utility and more for Django Ninja(Fast Django REST framework)
Project description
Django Ninja Extra
Django Ninja Extra package offers a class-based approach plus extra functionalities that will speed up your RESTful API development with Django Ninja
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
Full documentation, visit.
Example
Checkout this sample project: https://github.com/eadwinCode/bookstoreapi
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, api_controller, http_get
api = NinjaExtraAPI()
# function based definition
@api.get("/add", tags=['Math'])
def add(request, a: int, b: int):
return {"result": a + b}
#class based definition
@api_controller
class MathAPI:
@http_get('/subtract',)
def subtract(self, a: int, b: int):
"""Subtracts a from b"""
return {"result": a - b}
@http_get('/divide',)
def divide(self, a: int, b: int):
"""Divides a by b"""
return {"result": a / b}
@http_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):
Tutorials
- django-ninja - Permissions, Controllers & Throttling with django-ninja-extra! - Learn how to use permissions, controllers and throttling with django-ninja-extra
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.20.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1cf5534b035c3b905f47962958580a39f59dd4dde8d6d9fa0eac7e8f516a48bc |
|
MD5 | 988ac4d0da2cef26e8ebc02d7fb7401f |
|
BLAKE2b-256 | 9c6292aaba3e853b49eb65c573c3d49a7a91019c2756a7173839f53c5729ed60 |
Hashes for django_ninja_extra-0.20.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a925453d338dadd7c92f7ce9ba81f398df84d03ca8acc11189e46dd393dc9caf |
|
MD5 | 80d9dcc6300ca991c31a8ce35cafd61c |
|
BLAKE2b-256 | 583a4b8988b9d2a1ad66be4bc429177e32484f15f954a96bd332fac339d28456 |