Skip to main content

NinjaAPI - Fast Django REST Framework

Django Ninja

Django Ninja is a web framework for building APIs with Django and Python 3.6+ based type hints.

Documentation: https://django-ninja.rest-framework.com


Installation

pip install django-ninja

Usage

In your django project 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 alredy 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

Metadata

Release files for django-ninja 0.1.1

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.1.1
File Size Uploaded Provenance Actions
django-ninja-0.1.1.tar.gz 863.7 kB Without provenance Details for django-ninja-0.1.1.tar.gz

Built distribution (wheel)

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

Total release size: 881.8 kB

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

Download URL django-ninja-0.1.1.tar.gz
Size 863.7 kB
Tags Source
SHA-256 checksum
How to use checksums
fb1ddf84abf9b3beca03672093deca7057c43aba5a19818abfb493ad05a8667a
BLAKE2b-256 checksum
How to use checksums
c4e1dfc985059b01a568d3eae3b2975fbcddab33dbf9a4cfe733547192ad6b17
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.24.0

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

Download URL django_ninja-0.1.1-py3-none-any.whl
Size 18.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d2c49355e20ecd9c09136ec15e828645d79298606989948e919fdba77543a3b2
BLAKE2b-256 checksum
How to use checksums
89c2692fb4814975b6ea4ecde10be761f951c82bebfb5970a5ee85cea6d328d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.24.0

Security for django-ninja 0.1.1

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