This release is a pre-release and may not be stable for production use.
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+ type hints.
Key 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.
- Production ready: Used by multiple companies on live projects (If you use django-ninja and would like to publish your feedback, please email ppr.vitaly@gmail.com).
Documentation: https://django-ninja.dev
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 !
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 or Redoc):
Sponsors
What next?
- Read the full documentation here - https://django-ninja.dev
- To support this project, please give star it on Github.
- Share it via Twitter
- If you already using django-ninja, please share your feedback to ppr.vitaly@gmail.com
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_ninja-1.7.1a2.tar.gz.
File metadata
- Download URL: django_ninja-1.7.1a2.tar.gz
- Upload date:
- Size: 2.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6904b6b8156382a3dd5ba0c26dcd0caffbade4969f21ee59a38f54176035f8e1
|
|
| MD5 |
969fa07eec14cf9f47f8a87008aadcf7
|
|
| BLAKE2b-256 |
346ad4eaeeafbe6a48dc276811369975e2e8be6f93eba777b78f1db94881ed43
|
File details
Details for the file django_ninja-1.7.1a2-py3-none-any.whl.
File metadata
- Download URL: django_ninja-1.7.1a2-py3-none-any.whl
- Upload date:
- Size: 2.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
23fbda2481e29b299533dcd1ab26e2ffcb9335130205a5f34387e08406cc1ace
|
|
| MD5 |
632aa6a0dd56a9789d9a9d5f6c799358
|
|
| BLAKE2b-256 |
ae368aa7615ccb993100205a5e83eccf39e1a88721d4a020e6d86c649085364d
|
