Django Rest Framework 使用 ModelViewSet

K8sCat2023-10-10 14:31

Django Rest Framework (DRF) 是一个用于构建Web API的强大而灵活的工具集。ModelViewSet是DRF中的一个强大工具，它继承了Django的通用类视图，使得在创建RESTful API时更为简单有效。

什么是 ModelViewSet ?

ModelViewSet 是 Django Rest Framework 中的一个包含 create, retrieve, update, delete 和 list 操作的视图集。基本上，它允许你简化代码并优雅地处理 CRUD 操作。

如何使用 ModelViewSet ?

安装 Django Rest Framework

在开始使用 ModelViewSet 之前，你需要首先安装Django Rest Framework。你可以使用 pip 安装：

python 复制代码

pip install djangorestframework

然后在你的Django设置中，在应用列表中添加'rest_framework'。

示例应用

假定你有一个模型，我们称之为Product。

python 复制代码

class Product(models.Model):
    name = models.CharField(max_length=100)
    price = models.DecimalField(max_digits=10, decimal_places=2)
    quantity = models.IntegerField()

    def __str__(self):
        return self.name

然后定义一个序列化器：

python 复制代码

class ProductSerializer(serializers.ModelSerializer):
    class Meta:
        model = Product
        fields = ['name', 'price', 'quantity']

然后创建ModelViewSet：

python 复制代码

class ProductViewSet(viewsets.ModelViewSet):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer

这个模型ViewSet将提供 list，create，retrieve，update 和 destroy 操作。

最后，我们更新 urls.py 文件，使其指向我们的 API 视图集：

python 复制代码

from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import ProductViewSet

router = DefaultRouter()
router.register(r'products', ProductViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

在该文件中，我们创建一个默认的Router，然后注册我们的ProductViewSet。Router负责处理请求转到适当的视图。

这样，我们就可以通过API进行查询，创建更新和删除操作。

结论

ModelViewSet不仅让我们的代码更简洁，而且帮助我们在我们的应用程序中快速实现CRUD。虽然有时你可能需要更精细的控制，但在大多数情况下，ModelViewSet为快速构建RESTful API提供了一个很好的起点。