摘要
什么是rest:REST是所有Web應用都應該遵守的架構設計指導原則
rest設計有點: 1.客戶端-服務端分離 2..無狀態(tài)(Stateless):從客戶端的每個請求要包含服務器所需要的所有信息 3.緩存(Cachable):服務器返回信息必須被標記是否可以緩存,如果緩存永部,客戶端可能會重用之前的信息發(fā)送請求 4.統(tǒng)一接口優(yōu)點:提高交互的可見性黄橘,鼓勵單獨改善組件 5.支持按需代碼(Code-On-Demand 可選)
REST是面向資源進行的,而資源是通過URI進行暴露的悼沈。
REST同一個資源的一組不同的操作
1.django restful流程
models ----> Serialiers --->viewsets ---->routers --->urls ---->filters
2.配置settings.py文件
(1)INSTALLED_APPS 追加 rest_freamwork
image.png
(2)配置restful API的返回結果
REST_FRAMEWORK = {
# 分頁
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 2,
# 設置搜索---將版本換為3.4.6
'DEFAULT_FILTER_BACKENDS': ('rest_framework.filters.DjangoFilterBackend',
'rest_framework.filters.SearchFilter'),
# 返回結構自定義
'DEFAULT_RENDERER_CLASSES': (
'utils.RenderResponse.CustomJsonRenderer',
)
}
3.配置應用文件urls.py贱迟,設置路由
from rest_framework.routers import SimpleRouter
from django.conf.urls import url
router = SimpleRouter()
router.register(r'student', views.Studentsedit)
urlpatterns += router.urls
4.views.py文件中配置相關方法 ,實現(xiàn)CRUD
這里的方法要使用class
from rest_framework import mixins, viewsets
from stu.serializers import StudentSerializer
from rest_framework.response import Response
from stu.filters import StuFilter
class Studentsedit(mixins.ListModelMixin,
mixins.RetrieveModelMixin,
mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
mixins.CreateModelMixin,
viewsets.GenericViewSet):
# 查詢所有信息
queryset = Student.objects.all()
# 序列化
serializer_class = StudentSerializer
# 過濾
filter_class = StuFilter
# 重定義獲得 刪除后篩選出刪除狀態(tài)為0的,并且對其從大到小進行排序
def get_queryset(self):
query = self.queryset
return query.filter(s_delete=0).order_by('-id')
# 重定義刪除 實現(xiàn)軟刪除 使數(shù)據(jù)庫中的刪除狀態(tài)轉變絮供, 實際上數(shù)據(jù)依然留在數(shù)據(jù)庫中
def destroy(self, request, *args, **kwargs):
instance = self.get_object()
instance.s_delete = 1
instance.save()
return Response({'msg': '刪除成功', 'code': 200})
5.應用文件下新建過濾filters.py 和 序列化 serializers.py文件
(1)序列化 serializers
序列化的數(shù)據(jù)是json格式
from rest_framework import serializers
from stu.models import Student
class StudentSerializer(serializers.ModelSerializer):
# 重定義錯誤信息返回名
s_name = serializers.CharField(error_messages={
'blank': '用戶名不能為空',
'max_length': '用戶名不能超過10個字符串'
}, max_length=10)
s_tel = serializers.CharField(error_messages={
'blank': '電話號碼不能為空'
})
# 傳遞的字段
class Meta:
model = Student
fields = ['id', 's_name', 's_tel', 's_yuwen', 's_status', 's_operate_time']
# 顯示實例的關聯(lián)的地址
def to_representation(self, instance):
data = super().to_representation(instance)
try:
data['s_addr'] = instance.studentinfo.i_addr
except Exception as e:
data['s_addr'] = ''
data['s_status'] = dict(Student.STATUS)[data['s_status']]
return data
(2)定義過濾
import django_filters
from rest_framework import filters
from stu.models import Student
class StuFilter(filters.FilterSet):
name = django_filters.CharFilter('s_name', lookup_expr='icontains')
tel = django_filters.CharFilter('s_tel')
status = django_filters.CharFilter('s_status')
operate_time_min = django_filters.DateTimeFilter('s_operate_time', lookup_expr='gte')
operate_time_max = django_filters.DateTimeFilter('s_operate_time', lookup_expr='lte')
yuwen_min = django_filters.NumberFilter('s_yuwen', lookup_expr='gte')
yuwen_max = django_filters.NumberFilter('s_yuwen', lookup_expr='lte')
class Meta:
model = Student
fields = ['s_name', 's_tel', 's_yuwen', 's_status', 's_operate_time']
6.查詢
可以通過網(wǎng)頁直接查詢衣吠, 也可以通過postman軟件來進行操作