Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

SCR-20230123-m1t

^ Please read ^

Fast to learn, fast to code, fast to run

Test Coverage PyPI version Downloads

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).

Django Ninja REST Framework

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

Swagger UI

Sponsors

sendcloud-logo

Become a sponsor

What next?

Release files for django-ninja 1.7.0b1

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 1.7.0b1
File Size Uploaded Provenance Actions
django_ninja-1.7.0b1.tar.gz 2.3 MB Without provenance Details for django_ninja-1.7.0b1.tar.gz

Built distribution (wheel)

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

Total release size: 4.7 MB

Release files / django_ninja-1.7.0b1.tar.gz

Download URL django_ninja-1.7.0b1.tar.gz
Size 2.3 MB
Tags Source
SHA-256 checksum
How to use checksums
d3749e4a01862a3e08b8d5c2057a231f7cb6eac24c08dc2625101a87bf1ed84b
BLAKE2b-256 checksum
How to use checksums
df3a8ca007652b3818f57a24c44c52458248860f43dd90c3b3956da7e19b05b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.31.0

Release files / django_ninja-1.7.0b1-py3-none-any.whl

Download URL django_ninja-1.7.0b1-py3-none-any.whl
Size 2.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
6c7e1333994f14ba01892452e40c14e83eaf3891f8a4a7c57c19defab4c691d6
BLAKE2b-256 checksum
How to use checksums
c1066cd35b7acfba4b94ccb36b74eb7f4fa7b4e65d460e021a797e2a1b53d0f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.31.0

Security for django-ninja 1.7.0b1

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
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