Django Ninja - Fast Django REST framework
Project description
Fast to learn, fast to code, fast to run
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).
Documentation: https://django-ninja.rest-framework.com
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
andb
- 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):
What next?
- Read the full documentation here - https://django-ninja.rest-framework.com
- To support this project, please give star it on Github.
- Share it via Twitter
- If you already using django-ninja, please share your feedback to ppr.vitaly@gmail.com
Project details
Release history Release notifications | RSS feed
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-0.16.1.tar.gz
(1.6 MB
view hashes)
Built Distribution
django_ninja-0.16.1-py3-none-any.whl
(409.3 kB
view hashes)
Close
Hashes for django_ninja-0.16.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab429b7d4f6cc665657a0b834ce8af93c18cca1f4d2300c43cb2c17ccf35f43e |
|
MD5 | daf341726d442ce3dfe22827e832ce15 |
|
BLAKE2b-256 | 867c75299b3be95d009dfbcfbc97981d883d07668c151b3b097f08a2d504a624 |