Django--ApiView示例

1. 代码示例

python 复制代码
from django.contrib.auth.models import User
from rest_framework import serializers
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status

from .models import BookInfo

class BookInfoModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = BookInfo
        fields = '__all__'

class BookListView(APIView):
    def get(self, request):
        books = BookInfo.objects.all()
        serializer = BookInfoModelSerializer(books, many=True)
        return Response(serializer.data)

    def post(self, request):
        serializer = BookInfoModelSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

class BookDetailView(APIView):
    def get(self, request, pk):
        try:
            book = BookInfo.objects.get(pk=pk)
            serializer = BookInfoModelSerializer(book)
            return Response(serializer.data)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)

    def put(self, request, pk):
        try:
            book = BookInfo.objects.get(pk=pk)
            serializer = BookInfoModelSerializer(book, data=request.data)
            if serializer.is_valid():
                serializer.save()
                return Response(serializer.data)
            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)

    def delete(self, request, pk):
        try:
            book = BookInfo.objects.get(pk=pk)
            book.delete()
            return Response(status=status.HTTP_204_NO_CONTENT)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)

2. 代码详解

详细解释

这段代码是一个使用 APIView 构建 API 视图的示例,它可以用于构建 RESTful API。

1. 导入模块

  • from django.contrib.auth.models import User: 导入 User 模型,用于用户身份验证。
  • from rest_framework import serializers: 导入序列化器模块,用于将模型实例转换为可序列化的数据格式。
  • from rest_framework.views import APIView: 导入 APIView 基类,用于构建 API 视图。
  • from rest_framework.response import Response: 导入 Response 类,用于生成 HTTP 响应。
  • from rest_framework import status: 导入 HTTP 响应状态码。
  • from .models import BookInfo: 导入 BookInfo 模型,用于定义书籍信息。

2. 定义序列化器

  • class BookInfoModelSerializer(serializers.ModelSerializer): 定义一个名为 BookInfoModelSerializer 的序列化器类,用于序列化和反序列化 BookInfo 模型实例。
  • class Meta: 元类,用于配置序列化器类的属性。
  • model = BookInfo: 要序列化的模型类。
  • fields = '__all__': 要序列化的字段列表。默认情况下,fields 属性设置为 '__all__',表示序列化所有字段。也可以将 fields 属性设置为一个字段列表,以只序列化指定的字段。

3. 定义 API 视图

  • class BookListView(APIView): 定义一个名为 BookListView 的 API 视图,用于获取所有书籍信息。
  • def get(self, request): 定义 get 方法,用于处理 GET 请求。
  • books = BookInfo.objects.all(): 查询所有 BookInfo 对象。
  • serializer = BookInfoModelSerializer(books, many=True): 使用 BookInfoModelSerializer 序列化所有书籍信息,并设置 many=True 参数,表示序列化多个对象。
  • return Response(serializer.data): 返回一个包含序列化数据的响应。

4. 创建新的书籍信息

  • def post(self, request): 定义 post 方法,用于处理 POST 请求。
  • serializer = BookInfoModelSerializer(data=request.data): 使用 BookInfoModelSerializer 验证请求数据。
  • if serializer.is_valid(): 如果数据有效,则保存数据。
  • serializer.save(): 保存数据。
  • return Response(serializer.data, status=status.HTTP_201_CREATED): 返回一个包含序列化数据的响应,并设置状态码为 201(已创建)。
  • return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST): 如果数据无效,则返回一个包含错误信息的响应,并设置状态码为 400(错误请求)。

5. 获取单个书籍信息

  • class BookDetailView(APIView): 定义一个名为 BookDetailView 的 API 视图,用于获取、更新和删除单个书籍信息。
  • def get(self, request, pk): 定义 get 方法,用于处理 GET 请求,并接受一个 pk 参数,表示要获取的书籍的 ID。
  • try: 尝试查询指定 pkBookInfo 对象。
  • book = BookInfo.objects.get(pk=pk): 查询指定 pkBookInfo 对象。
  • serializer = BookInfoModelSerializer(book): 使用 BookInfoModelSerializer 序列化书籍信息。
  • return Response(serializer.data): 返回一个包含序列化数据的响应。
  • except BookInfo.DoesNotExist: 如果书籍不存在,则返回一个 404(未找到)响应。

6. 更新单个书籍信息

  • def put(self, request, pk): 定义 put 方法,用于处理 PUT 请求,并接受一个 pk 参数,表示要更新的书籍的 ID。
  • try: 尝试查询指定 pkBookInfo 对象。
  • book = BookInfo.objects.get(pk=pk): 查询指定 pkBookInfo 对象。
  • serializer = BookInfoModelSerializer(book, data=request.data): 使用 BookInfoModelSerializer 验证请求数据,并使用 book 对象作为初始数据。
  • if serializer.is_valid(): 如果数据有效,则更新数据。
  • serializer.save(): 更新数据。
  • return Response(serializer.data): 返回一个包含序列化数据的响应。
  • return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST): 如果数据无效,则返回一个包含错误信息的响应,并设置状态码为 400(错误请求)。
  • except BookInfo.DoesNotExist: 如果书籍不存在,则返回一个 404(未找到)响应。

7. 删除单个书籍信息

  • def delete(self, request, pk): 定义 delete 方法,用于处理 DELETE 请求,并接受一个 pk 参数,表示要删除的书籍的 ID。
  • try: 尝试查询指定 pkBookInfo 对象。
  • book = BookInfo.objects.get(pk=pk): 查询指定 pkBookInfo 对象。
  • book.delete(): 删除书籍信息。
  • return Response(status=status.HTTP_204_NO_CONTENT): 返回一个 204(无内容)响应,表示书籍已删除。
  • except BookInfo.DoesNotExist: 如果书籍不存在,则返回一个 404(未找到)响应。

总结

这段代码是一个使用 APIView 构建 API 视图的示例,它可以用于构建 RESTful API。它包括以下功能:

  • 获取所有书籍信息
  • 创建新的书籍信息
  • 获取单个书籍信息
  • 更新单个书籍信息
  • 删除单个书籍信息
相关推荐
码农小旋风1 小时前
详解K8S--声明式API
后端
Peter_chq1 小时前
【操作系统】基于环形队列的生产消费模型
linux·c语言·开发语言·c++·后端
Yaml42 小时前
Spring Boot 与 Vue 共筑二手书籍交易卓越平台
java·spring boot·后端·mysql·spring·vue·二手书籍
小小小妮子~2 小时前
Spring Boot详解:从入门到精通
java·spring boot·后端
hong1616882 小时前
Spring Boot中实现多数据源连接和切换的方案
java·spring boot·后端
阡之尘埃2 小时前
Python数据分析案例61——信贷风控评分卡模型(A卡)(scorecardpy 全面解析)
人工智能·python·机器学习·数据分析·智能风控·信贷风控
睡觉谁叫~~~3 小时前
一文解秘Rust如何与Java互操作
java·开发语言·后端·rust
丕羽5 小时前
【Pytorch】基本语法
人工智能·pytorch·python
2401_865854885 小时前
iOS应用想要下载到手机上只能苹果签名吗?
后端·ios·iphone
bryant_meng5 小时前
【python】Distribution
开发语言·python·分布函数·常用分布