Fast to learn, fast to code, fast to run
Django Ninja - Fast Django REST Framework
Django Ninja is a web framework for building APIs with Django and Python 3.6+ based type hints.
Key features
- Easy: Designed to be easy to use and intuitive.
- Fast: Very high performance thanks to Pydantic and async support.
- Fast to code: Type hints and automatic docs let's you focus only on business logic.
- Standards-based: Based on the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema.
Documentation: https://django-ninja.rest-framework.com
Installation
pip install django-ninja
Usage
In your django project next to urls.py create new api.py file:
from ninja import NinjaAPI
api = NinjaAPI()
@api.get("/add")
def add(request, a: int, b: int):
return {"result": a + b}
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 !
And you already have:
- API that receives HTTP GET request at /api/add
- Takes, validates and type-casts GET parameters
aandb - Decodes to JSON operation result
- 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):
Next
- Read full documentation here - Documentation: https://django-ninja.rest-framework.com
- To support this project - just simply give it a start on github.
Metadata
Release files for django-ninja 0.5.0
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 | Actions |
|---|---|---|---|---|
| django-ninja-0.5.0.tar.gz | 942.7 kB | Without provenance | Details for django-ninja-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| django_ninja-0.5.0-py3-none-any.whl | Python 3 | none | any | Details for django_ninja-0.5.0-py3-none-any.whl |
Total release size: 963.4 kB
Release files / django-ninja-0.5.0.tar.gz
| Download URL | django-ninja-0.5.0.tar.gz |
|---|---|
| Size | 942.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
af2d59c121cdd3b8d2c1d5c39abac03c986a2a684c0f1336ee3ac2366734f13b
|
|
BLAKE2b-256 checksum How to use checksums |
749a0ac5bdd7344a831201d3ce8fda14519828342d334605fe884f590a4a4824
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.24.0
|
Release files / django_ninja-0.5.0-py3-none-any.whl
| Download URL | django_ninja-0.5.0-py3-none-any.whl |
|---|---|
| Size | 20.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4e112c24b9b197fea4722ab14519bd52e814f6f98028a8d827215806b6981c3f
|
|
BLAKE2b-256 checksum How to use checksums |
36956ed6ea1a1f0d50e522c3ea042b88c48f69cd89f251fcbc7058268d600a7a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.24.0
|
Security for django-ninja 0.5.0
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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.