NinjaAPI - Fast Django REST framework
Project description
NinjaAPI - Fast Django REST Framework
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
aandb - 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):
Next
- To support this project - just simply give it a start on github.
- Read full documentation here - Documentation: https://django-ninja.rest-framework.com
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.1.1.tar.gz
(863.7 kB
view hashes)
Built Distribution
Close
Hashes for django_ninja-0.1.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d2c49355e20ecd9c09136ec15e828645d79298606989948e919fdba77543a3b2 |
|
| MD5 | bad229b7469d964dd8b8ee452874b28d |
|
| BLAKE2b-256 | 89c2692fb4814975b6ea4ecde10be761f951c82bebfb5970a5ee85cea6d328d6 |
