Skip to main content

Fast to learn, fast to code, fast to run

Test Coverage PyPI version

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.
  • Django friendly: (obviously) have good integration with 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 to ppr.vitaly@gmail.com)

Django Ninja REST Framework

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 a and b
  • 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):

Swagger UI

Next

Release files for django-ninja 0.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-ninja 0.10.0
File Size Uploaded Provenance Actions
django-ninja-0.10.0.tar.gz 1.6 MB Without provenance Details for django-ninja-0.10.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for django-ninja 0.10.0
File Interpreter ABI Platform Actions
django_ninja-0.10.0-py3-none-any.whl Python 3 none any Details for django_ninja-0.10.0-py3-none-any.whl

Total release size: 2.0 MB

Release files / django-ninja-0.10.0.tar.gz

Download URL django-ninja-0.10.0.tar.gz
Size 1.6 MB
Tags Source
SHA-256 checksum
How to use checksums
66e8393a9d66c3349c877bc9ee3b0d500a4cd6061363f386d7d3364e611bd0e3
BLAKE2b-256 checksum
How to use checksums
dcbe353ee1799615a6ec9fe4ba5b2dc604a2bc3c1d2288379d939fe68b0b55f3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.24.0

Release files / django_ninja-0.10.0-py3-none-any.whl

Download URL django_ninja-0.10.0-py3-none-any.whl
Size 375.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8faa80513e9828f19788f7fb15e6e95e0dcaf4902c1a080a2d2f581f533a96bc
BLAKE2b-256 checksum
How to use checksums
3b4ed42839fa5b08bf516d76c90dcbaa838adb8f3524fb33aaccd55dc5e4ea7a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.24.0

Security for django-ninja 0.10.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.

Release history Release notifications | RSS feed

This release

0.10.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page