使用Django REST framework开发RESTful API接口2

最新推荐文章于 2025-04-03 18:32:36 发布

原创最新推荐文章于 2025-04-03 18:32:36 发布 · 485 阅读

3 ·

CC 4.0 BY-SA版权

Python 专栏收录该内容

22 篇文章

订阅专栏

本文介绍如何使用 Django REST framework 实现序列化操作，包括创建序列化器、定义视图函数及路由，实现课程信息的获取、新增、更新与删除。

序列化

把Django数据类型转化为json/xml，方便前端渲染。

在course应用下新建serializers.py文件

from django import forms
from django.contrib.auth.models import User
from rest_framework import serializers

from .models import Course


# class CourseForm(forms.ModelForm):
#     class Meta:
#         model = Course
#         fields = ('name', 'introduction', 'teacher', 'price')


class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = '__all__'


class CourseSerializer(serializers.ModelSerializer):
    teacher = serializers.ReadOnlyField(source='teacher.username')  # 外键字段 只读

    class Meta:
        model = Course  # 写法和上面的CourseForm类似
        fields = '__all__'
        depth = 2



# class CourseSerializer(serializers.HyperlinkedModelSerializer):
#     teacher = serializers.ReadOnlyField(source='teacher.username')
# 
#     class Meta:
#         model = Course
#         # url是默认值，可在settings.py中设置URL_FIELD_NAME使全局生效
#         fields = ('id', 'url', 'name', 'introduction', 'teacher', 'price', 'created_at', 'updated_at')

函数式编程 Function Based View

获取课程列表

打开views.py

from rest_framework.decorators import api_view

from course.models import Course
from course.serializers import CourseSerializer
from rest_framework.response import Response
from rest_framework import status
""" 函数式编程 Function Based View
        @api_view 装饰器
"""


@api_view(["GET", "POST"])
def course_list(request):
    """
    获取所有课程信息或新增一个课程
    :param request:
    :return:
    """
    if request.method == 'GET':
        # 序列化多个对象 many=True
        s = CourseSerializer(instance=Course.objects.all(), many=True)
        return Response(data=s.data, status=status.HTTP_200_OK)

    elif request.method == 'POST':
        # 反序列化
        s = CourseSerializer(data=request.data)  # 部分更新用partial=True属性
        # 反序列化需要校验
        if s.is_valid():
            # 设置当前用户
            s.save(teacher=request.user)
            return Response(data=s.data, status=status.HTTP_201_CREATED)
        return Response(s.errors, status=status.HTTP_400_BAD_REQUEST)

添加路由验证。
在course应用下新建urls.py文件。

from django.urls import path, include
from course import views

urlpatterns = [
    # FBV
    path("fbv/list", views.course_list, name="fbv-list"),

]

打开项目路由文件urls.py，添加path('course/', include('course.urls'))。
运行进行验证。
由于在项目settings.py配置了全局登陆校验。
在这里插入图片描述

当你出现登陆框的时候输入你注册的超级用户账号密码即可。
在这里插入图片描述

出现上图表示登陆成功，可以点手动添加一个对象，点击POST进行校验接口。

获取、更新、删除单个课程

继续在course_list函数下面新建course_details函数。

@api_view(["GET", "PUT", "DELETE"])
def course_details(request, pk):
    """
    获取、更新、删除一个课程
    :param request:
    :param pk: primary key 主键的意思
    :return:
    """
    try:
        # 因为可能查询不到，所以加上 try
        course = Course.objects.get(pk=pk)
    except Course.DoesNotExist:
        return Response(data={"msg": "没有此课程信息"}, status=status.HTTP_404_NOT_FOUND)
    else:
        if request.method == "GET":
            s = CourseSerializer(instance=course)
            return Response(data=s.data, status=status.HTTP_200_OK)
        if request.method == "PUT":
            # instance序列化查询到的对象
            # data 获取前端传来的数据
            s = CourseSerializer(instance=course, data=request.data)
            if s.is_valid():
                # 因为这是修改，teacher已经存在了，所以直接保存
                s.save()
                return Response(data=s.data, status=status.HTTP_200_OK)
            return Response(data=s.errors, status=status.HTTP_400_BAD_REQUEST)
        if request.method == "DELETE":
            course.delete()
            return Response(status=status.HTTP_204_NO_CONTENT)

打开course应用添加路由

urlpatterns = [
    # FBV 
    path('fbv/list', views.course_list, name="fbv-list"),  # name 表示网页返回显示的路由地址
    path('fbv/details/<int:pk>', views.course_details, name="fbv-details")
]