Skip to main content

Django Ninja - Fast Django REST framework

Project description

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

What next?

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_ninja-1.4.3.tar.gz (3.7 MB view details)

Uploaded Source

Built Distribution

django_ninja-1.4.3-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

Details for the file django_ninja-1.4.3.tar.gz.

File metadata

  • Download URL: django_ninja-1.4.3.tar.gz
  • Upload date:
  • Size: 3.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for django_ninja-1.4.3.tar.gz
Algorithm Hash digest
SHA256 e46d477ca60c228d2a5eb3cc912094928ea830d364501f966661eeada67cb038
MD5 311fe4b35fd07b010a4020f9c7d7d93a
BLAKE2b-256 cd1af0d051f54375cfd2310f803925993fdc4172e41e627d63ece48194b07892

See more details on using hashes here.

File details

Details for the file django_ninja-1.4.3-py3-none-any.whl.

File metadata

  • Download URL: django_ninja-1.4.3-py3-none-any.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for django_ninja-1.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f3204137a059437b95677049474220611f1cf9efedba9213556474b75168fa01
MD5 b694009509c5b011c9338ec1fe9e3e06
BLAKE2b-256 08ec0cfa9b817f048cdec354354ae0569d7c0fd63907e5b1f927a7ee04a18635

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page