设计RESTful风格的文档接口

1. 安装第三方库 djangorestframework

pip install djangorestframework

2. 注册rest_framework

# settings.py
INSTALLED_APPS = [
    'rest_framework'
]

3. 序列化模型

# serializers.py
from rest_framework import serializers
from car.models import Record

class RecordSerializer(serializers.ModelSerializer):

    class Meta:
        model = Record
        fields = '__all__'

4. 视图集

# views.py
from car.serializers import RecordSerializer

class SearchViewSet(ModelViewSet):
    queryset = Record.objects.all().order_by('-makedate')
    serialize_class = RecordSerializer
    
# urls.py
router = DefaultRouter()
router.register('records', SearchViewsSet)
urlpatterns += router.urls

5. CBV (Class-Based View) 代码量少,简单方便

# views.py
class SearchView(ListCreateAPIView, DestoryAPIView):
    queryset = Record.objects.all().order_by('-makedate')
    serialize_class = RecordSerializer
# urls.py
urlpatterns = [
  path('records', SearchView.as_view())
]

6. FBV (Function-Based View) 灵活,完全自己定制,但代码较多

# views.py
@api_view(['GET', 'POST'])
def search(request):
    if request.method == 'POST':
        record = Record()
        record.save()
        serializer = RecordSerializer(record)
    else:
        queryset = Record.objects.all()
        serializer = RecordSerializer(queryset, many=True)
    return Response(serializer.data)

7. 实现分页功能

# 设置默认分页
# settings.py

REST_FRAMEWORK = {
    # 每页显示5个结果 
    'PAGE_SIZE':5,
    'DEFAULT_PAGINATION_CLASS':'rest_framework.pagination.PageNumberPagination'
}
# 自定义分页
# views.py
class CustomPagination(PageNumberPagination):
    page_size = 5
    page_size_query_param = 'size'
    max_page_size = 50

class SearchViewSet(ModelViewSet):
    queryset = Record.objects.all().order_by('-makedate')
    serializer_class = RecordSerializer
    pagination_class = CustomPagination
    

8. 数据过滤

8.1 自定义过滤器

class RecordFilter(FilterSet):
    carno_or_owner = django_filters.CharFilter(method='search', label='输入车牌号或车主姓名')
    @staticmethod
    def search(queryset, name, value):
        return queryset.filter(Q(carno=normalize_carno(value)) |
                               Q(owner__icontains=value))

8.2 在视图集中加上过滤器

class SearchViewSet(ModelViewSet):
    # 获取所有对象
    # 数据序列化
    # 添加分页规则
    # 添加过滤器
    filter_backends = (DjangoFilterBackend, OrderingFilter)
    filter_class = RecordFilter
    # 可选过滤选择
    # filterset_fields = ('carno', 'owner', )
    # 默认排序方式
    ordering = ('-makedate', )
    # 可选排序方式
    ordering_fields = ('carno', 'makedate', )
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,509评论 6 504
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,806评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,875评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,441评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,488评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,365评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,190评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,062评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,500评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,706评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,834评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,559评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,167评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,779评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,912评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,958评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,779评论 2 354

推荐阅读更多精彩内容

  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,100评论 1 32
  • 1, 序列化 Serialization 创建一个新环境 在做其他事之前,我们会用virtualenv创建一个新的...
    光着脚的鞋阅读 683评论 0 1
  • 注意:这是版本3的文档。还提供了版本2的文档。 Django REST framework 是一个强大且灵活的工具...
    鹏ve阅读 4,537评论 0 6
  • 今天大年初二,我和妈妈去我姥姥家走亲戚去的,一路上这天阴沉沉的,看起来似乎要下雪,我们今天走的早,所以在高速路...
    冰凉的琉璃阅读 502评论 2 4
  • 曾经以为爱上你是最幸福的事 后来发现那是可望不可及的事 后来呀 我们还是在一起了 然而我有一种患得患失的感觉 害怕...
    小小丰兄阅读 156评论 4 1