# django-ninja
**Repository Path**: mirrors_vitalik/django-ninja
## Basic Information
- **Project Name**: django-ninja
- **Description**: 💨 Fast, Async-ready, Openapi, type hints based framework for building APIs
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-01-06
- **Last Updated**: 2025-09-21
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
^ Please read ^
Fast to learn, fast to code, fast to run
  [](https://badge.fury.io/py/django-ninja) [](https://pepy.tech/project/django-ninja) # 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.dev --- ## Installation ``` pip install django-ninja ``` ## Usage In your django project next to urls.py create new `api.py` file: ```Python 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: ```Python hl_lines="3 7" ... 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):  ## Sponsors