【亲测免费】 Django Ninja CRUD 使用教程

项目介绍

Django Ninja CRUD 是一个声明式的框架，它通过 Django Ninja 来革新构建 API 的方式。该框架使开发者能够创建高度可定制、可重用和模块化的 API 视图，从基本的 CRUD（创建、读取、更新、删除）操作到复杂的自定义操作。

项目快速启动

安装

首先，使用 pip 安装 Django Ninja CRUD：

pip install django-ninja-crud

配置

在你的 Django 项目中，配置 settings.py 文件以包含 Django Ninja CRUD：

INSTALLED_APPS = [
    ...
    'ninja_crud',
    ...
]

创建模型和视图

定义一个简单的 Department 模型：

# examples/models.py
from django.db import models

class Department(models.Model):
    title = models.CharField(max_length=255, unique=True)

创建输入和输出模式：

# examples/schemas.py
from ninja import Schema

# 用于创建/更新部门
class DepartmentIn(Schema):
    title: str

# 用于检索部门数据
class DepartmentOut(Schema):
    id: int
    title: str

设置视图：

# examples/views.py
from typing import List
from ninja import NinjaAPI
from ninja_crud import views, viewsets
from examples.models import Department
from examples.schemas import DepartmentIn, DepartmentOut

api = NinjaAPI()

class DepartmentViewSet(viewsets.APIViewSet):
    api = api
    model = Department

    list_departments = views.ListView(response_body=List[DepartmentOut])
    create_department = views.CreateView(request_body=DepartmentIn, response_body=DepartmentOut)
    read_department = views.ReadView(response_body=DepartmentOut)
    update_department = views.UpdateView(request_body=DepartmentIn, response_body=DepartmentOut)
    delete_department = views.DeleteView()

应用案例和最佳实践

案例：大学部门系统

使用 Django Ninja CRUD 创建一个完整的 API 来管理大学部门系统。这个例子将展示如何用最少的代码设置模型、模式和视图。

最佳实践

1. 模块化设计：将模型、模式和视图分别放在不同的文件中，以保持代码的清晰和可维护性。
2. 错误处理：在视图中添加适当的错误处理逻辑，以确保 API 的健壮性。
3. 权限控制：根据需要添加权限控制，确保只有授权用户可以执行特定的操作。

典型生态项目

Django Ninja CRUD 可以与其他 Django 生态系统项目无缝集成，例如：

1. Django REST Framework：用于构建更复杂的 API。
2. Django Ninja：用于声明式 API 视图。
3. Django Channels：用于 WebSocket 支持。

通过这些集成，可以构建功能丰富且高效的 Web 应用程序。