django restful API

摘要

什么是rest:REST是所有Web应用都应该遵守的架构设计指导原则
rest设计有点: 1.客户端-服务端分离 2..无状态(Stateless):从客户端的每个请求要包含服务器所需要的所有信息 3.缓存(Cachable):服务器返回信息必须被标记是否可以缓存,如果缓存,客户端可能会重用之前的信息发送请求 4.统一接口优点:提高交互的可见性,鼓励单独改善组件 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文件中配置相关方法 ,实现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

    # 重定义获得  删除后筛选出删除状态为0的,并且对其从大到小进行排序
    def get_queryset(self):
        query = self.queryset
        return query.filter(s_delete=0).order_by('-id')

    # 重定义删除  实现软删除  使数据库中的删除状态转变, 实际上数据依然留在数据库中
    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
序列化的数据是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']

# 显示实例的关联的地址
    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.查询

可以通过网页直接查询, 也可以通过postman软件来进行操作

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,440评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,814评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,427评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,710评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,625评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,014评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,511评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,162评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,311评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,262评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,278评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,989评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,583评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,664评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,904评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,274评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,856评论 2 339

推荐阅读更多精彩内容