Skip to content

πŸ’¨ Fast, Async-ready, Openapi, type hints based framework for building APIs

License

Notifications You must be signed in to change notification settings

vitalik/django-ninja

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jun 27, 2024
49e8b80 Β· Jun 27, 2024
May 24, 2024
Jun 26, 2024
Jun 27, 2024
Aug 8, 2022
Jun 27, 2024
Jun 20, 2020
Nov 21, 2023
Apr 30, 2024
Apr 7, 2024
Jan 4, 2023
Apr 7, 2024
Dec 19, 2023
Nov 22, 2023
Apr 30, 2024

Repository files navigation

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?