[Python知识库](二)序列化介绍及基于函数的API

第一集：《(一)django Rest Framework简单理解&练习创建项目》
第二集：《(二)序列化介绍及基于函数的API》

API的简单描述

# 接口描述 用户列表
# 接口地址 http://127.0.0.1:8000/api/user
# 请求方式 POST GET 
# 返回参数 JSON格式的用户列表及状态码

# 接口描述 用户详情
# 接口地址 http://127.0.0.1:8000/api/user/{id}
# 请求方式 GET, PUT, DELETE
# 返回参数 用户详情及状态码(GET, PUT) 状态码(DELETE)

自定义序列化器

前面一章《(一)django Rest Framework简单理解&练习创建项目》已经创建了项目、模型和数据，现在直接进入主题。

写接口往往都是从自定义序列化器开始的，序列化器的作用是把模型实例（如用户列表、用户详情）序列化和反序列化为如JSON格式的数据。不过，一个用户的详情还会包含密码，密码是不可能传输到前端去的，所以我们可以简单理解为并非所有的数据都需要序列化传输到前端，DRF的序列化器还可以定义序列化哪些字段。

编写好序列化器，在对应的view中调用就可以了，可简单理解为：
GET请求时：requests -> view -> 数据库读数据 -> 数据经过序列化器处理(序列化) -> 响应
POST请求或其他请求： request -> view -> 前端传过来的已被序列化的数据，序列化器处理(反序列化) -> 数据库保存 -> 响应

• 使用Serializers类

使用这个类来创建序列化器，要做的工作会多一些，要自定义每一个字段。
在项目的user下创建文件：serializers.py，user相关的序列化器全部写在里面。

from rest_framework import serializers
from .models import User, Company

# serializers.Seriazers处理办法
class UserSerializer(serializers.Serializer):
    id = serializers.IntegerField(read_only=True)
    user_name = serializers.CharField(unique=True, max_length=20) #options的设置是用来验证的，和model中的保持一直
    nick_name = serializers.CharField(unique=True, max_length=30) #options的设置是用来验证的，和model中的保持一直
    password = serializers.CharField(max_length=20)
    company = serializers.ReadOnlyField(source="company.id")

    def create(self, validated_data):
        """
        创建一个用户
        """
        return User.objects.create(**validated_data)
    
    def update(self, instance ,validate_data):
        """
        更新一个用户信息
        """
        instance.user_name = validate_data.get('user_name', instance.user_name)
        instance.nick_name = validate_data.get('nick_name', instance.nick_name)
        instance.save()
        return instance

编写views和urls

#views.py
from django.shortcuts import render
from . models import User

from rest_framework.decorators import api_view
from rest_framework.response import Response
from . serializers import UserSerializer

@api_view(['GET', 'POST'])
def users_list(request):
    if request.method == 'GET':
        users = User.objects.all()
        serializer = UserSerializer(users, many=True)
        return Response(serializer.data)
    
    pass

#总路由
from django.contrib import admin
from django.urls import path, include
from user.models import User

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('user.urls')),
]

#子路由
from django.urls import path
from .views import users_list

urlpatterns = [
    path('user/', users_list),
]

浏览器中请求http://127.0.0.1:8000/api/user/users/

成功响应了请求。

待续。。。