Skip to main content

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

v1.0 What's new

Read more details here - https://django-ninja.dev/whatsnew_v1/

Or Watch here:

SCR-20231116-qmoj

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

What next?

Release files for django-ninja 1.2.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 1.2.0
File Size Uploaded Provenance Actions
django_ninja-1.2.0.tar.gz 3.7 MB Without provenance Details for django_ninja-1.2.0.tar.gz

Built distribution (wheel)

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

Total release size: 6.1 MB

Release files / django_ninja-1.2.0.tar.gz

Download URL django_ninja-1.2.0.tar.gz
Size 3.7 MB
Tags Source
SHA-256 checksum
How to use checksums
0a7b7e20202f50546ae45af6a262fccb606c9e75b8bbe9fe38d49075a9435bf0
BLAKE2b-256 checksum
How to use checksums
8396cb1c6b1334e03e0e6e733181fa737ba0928e3e5f0f1eda6baddaa799b6c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.3

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

Download URL django_ninja-1.2.0-py3-none-any.whl
Size 2.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
aa8ca853bf189cc13247b1922ca41f1a6e60056c90041ec0081cce0ea8d8de02
BLAKE2b-256 checksum
How to use checksums
4dc6cded95c59928f7bd097d663c10b6e3b8071ee1c4b6972999cf081ae7e89f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.3

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

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