🐍 Django Ninja: Что это и как оно работает?

🔎 Django Ninja - это фреймворк для создания веб-серверов и API на основе Django.

Он предоставляет простой и интуитивно понятный способ создания API, используя Python и Django.

Вот пример кода, который показывает, как создать простой эндпоинт с использованием Django Ninja:

from django.http import JsonResponse
from django_ninja import Router

router = Router()

@router.get("/hello")
def hello(request):
    return JsonResponse({"message": "Привет, мир!"})

Что такое Django Ninja?

Django Ninja - это фреймворк для создания веб-приложений API с использованием Django и Python 3.7+ типизации:

1. Установка Django Ninja

Для установки Django Ninja вы можете использовать pip:

pip install django-ninja

2. Начало работы

Чтобы начать работу с Django Ninja, вам нужно создать новый проект Django или добавить его к существующему проекту.

3. Создание нового ninja API

Создайте новый файл с расширением .py и добавьте следующий код:

from django_ninja import router, HttpResponse
from ninja import Router

router = Router()

@router.get("/hello")
def hello(request):
    return HttpResponse("Hello, Ninja!")

# Обратите внимание: здесь мы используем router.urls, а не urlpatterns.
# Рекомендуется размещать ваш API по /api/... , поэтому мы это делаем здесь.
urlpatterns = [
    path("api/", include(router.urls)),
]

4. Запуск сервера

Теперь вы можете запустить сервер, используя следующую команду:

python manage.py runserver

5. Проверка вашего ninja API

Откройте веб-браузер и перейдите по адресу http://localhost:8000/api/hello. Вы должны увидеть текст "Hello, Ninja!"

6. Добавление дополнительных функций

Вы также можете добавить различные функции к вашему API и настраивать их поведение с помощью различных декораторов Django Ninja.

7. Поддержка запросов HTTP

Django Ninja поддерживает различные типы запросов HTTP, такие как GET, POST, PUT, DELETE, и т.д. Вы можете использовать соответствующие декораторы для определения поведения API для каждого типа запроса.

8. Документация API

Django Ninja также предоставляет автоматическую документацию API, которая может быть полезна для разработчиков. Она доступна по адресу /api/schema/swagger/ после запуска сервера.

Заключение

В этой статье мы рассмотрели, что такое Django Ninja и как начать создавать веб-приложения API с его помощью. Мы также ознакомились с основными функциями и возможностями фреймворка Django Ninja. Теперь вы можете приступить к созданию своих собственных мощных и гибких API с использованием Django Ninja и Python.