Django前后端分离开发-新闻管理系统(三)

项目源码下载:https://github.com/Cherish-sun/NEWS/tree/master

一、view 视图(实现新闻类别的api)

drf为我们提供强大的通用view的功能
主要的几种view以及他们之间的关系


view关系图

这其中,还涉及了mixins,主要也分为5类


mixis

建议在做drf的时候,使用ViewSet与mixins方法结合进行开发
• 路由系统是用于接收合适的请求,然后返回相应的响应
• REST框架允许将一系列相关的业务逻辑函数写在一起,称为ViewSet.在其他框架中,相似的

实现也被称为’Resources’或者’Controllers’.
• 一个ViewSet类也是一个基础的View类,不提供任何请求处理函数,如get或post,只提供类似
list和created这样的方法
• 一个ViewSet类,通过.as_view() method绑定到相应的url上
• 一般不需要在路由管理器中另外注册视图函数,只需要注册这个viewset类就够了,然后就
会自动帮你处理

• ViewSet

class ViewSet(ViewSetMixin, views.APIView):
继承自APIView,利用permission_classes, authentication_classes等来控制API策略 。一般都需要重写此类中的方法

• GenericViewSet

class GenericViewSet(ViewSetMixin, generics.GenericAPIView):
GenericViewSet继承自GenericAPIView,提供了一系列如get_object, get_queryset方法,如果使用此类,需要重写此类或者与mixin类进
行组合

• ModelViewSet

class ModelViewSet(mixins.CreateModelMixin,
mixins.RetrieveModelMixin,
mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
mixins.ListModelMixin,
GenericViewSet):
也是继承自GenericAPIView,通过mixin类,实现了一些具体的操作,.list(), .retrieve(), .create(), .update(), .partial_update(), 和 .destroy
()。

• ReadOnlyModelViewSet

class ReadOnlyModelViewSet(mixins.RetrieveModelMixin,
mixins.ListModelMixin,
GenericViewSet):
也是继承自GenericAPIView,仅提供只读操作,.list()和.retrieve()


ModelViewSet关系图

二、view.py代码

from rest_framework import viewsets
from .models import Category, Item, Tag, Article, Ad, UserFav, User
from .serilaizes import UserRegSerializer, UserDetailSerializer, UserLoginSerializer, UserSetPasswordSerializer
from .serilaizes import UserFavSerializer, UserFavDetailSerializer, CategoryStringSerializer, \
CategoryPrimaryKeySerializer, CategorySlugSerializer
from .serilaizes import CategorySerializer, ItemSerializer, TagSerializer, AdSerializer, ArticleSerializer, \
Hot_articleSerializer, CategoryitemsSerializer
from rest_framework.decorators import api_view
from rest_framework import mixins


# class CategoryViewset(mixins.ListModelMixin, mixins.RetrieveModelMixin, viewsets.GenericViewSet):
class CategoryViewset(viewsets.ModelViewSet):
    """
    list:
       GET url: /category/   分类列表数据
    creat:
       POST url: /category/  创建分类详情
    retrieve:
       GET url: /category/1/  获取分类详情
    update:
       PUT url: /category/1/  修改分类详情
    delete:
       DELETE url: /category/1/  删除分类详情
    """
    # 查询对象集
    queryset = Category.objects.all()
    # 序列化的类名
    serializer_class = CategorySerializer
    lookup_field = "id"


# class CategoryitemsViewset(mixins.ListModelMixin, mixins.RetrieveModelMixin, viewsets.GenericViewSet):
class CategoryitemsViewset(viewsets.ReadOnlyModelViewSet):
    """
    list:
        分类列表数据
    retrieve:
        获取分类详情
    """
    # 查询对象集
    queryset = Category.objects.all()
    # 序列化的类名
    serializer_class = CategoryitemsSerializer
    lookup_field = "id"


class ItemViewset(viewsets.ModelViewSet):
    """
    list:
       GET url: /item/   子类列表数据
    creat:
       POST url: /item/  创建子类详情,返回新生成的子类对像
    retrieve:
       GET url: /item/1/  获取子类详情,返回子类对像
    update:
       PUT url: /item/1/  修改子类详情,返回子类对像
    delete:
       DELETE url: /item/1/  删除子类详情,返回空对像
    """
    # 用于从此视图返回对象的查询器集。

    queryset = Item.objects.all()

    # filter_backends = (DjangoFilterBackend, filters.SearchFilter, filters.OrderingFilter)
    # 查询
    # filter_class = ItemFilter
    # SearchFilter对应search_fields,对应模糊查询,也可用关连表的字段进行查询,但需要二个下划线连接,如categorys__title
    search_fields = ('title', 'categorys__title')
    # 用于验证和反序列化输入以及序列化输出的serializer类。通常,您必须设置此属性,或覆盖该get_serializer_class()方法。
    serializer_class = ItemSerializer
    # 应用于执行单个模型实例的对象查找的模型字段。默认为’pk’。
    lookup_field = "id"

四、配置url.py 路由

from django.contrib import admin
from django.urls import path
import article.views as view
from rest_framework.routers import DefaultRouter

# 建立一个路由对象
router = DefaultRouter()
# 将我们的路由注册到url里
router.register(r'category', view.CategoryViewset, base_name='category')
router.register(r'categoryitems', view.CategoryitemsViewset, base_name='categoryitems')
router.register(r'item', view.ItemViewset, base_name='item')

urlpatterns = [
    path('admin/', admin.site.urls),
]
urlpatterns += router.urls
浏览器打开http://127.0.0.1:8000/
效果图

category

categoryitems

item

五、安装集成自动生成文档工具--swagger

pip install coreapi
pip install django-rest-swagger
settings.py 中
INSTALLED_APPS = [
    ...
    'rest_framework_swagger',
    ... ]
urls.py
from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title='新闻系统 API')
urlpatterns = [
    re_path('^$', schema_view),
    …

再刷新下浏览器,你会惊喜发现!!!(过程中可能会报错,本人也是新手一路踩坑,坚持住,遇到bug问度娘,加油 )


swagger工具

六、序列化类三个关键字段类型在web api中的使用

1、上面分别写了分类category、分类子栏目categoryitems、所有子栏目item的API,接下来要实现在item中只要子栏目的主键、子栏目的名称、或者指定的相关字段。

class CategoryStringSerializer(serializers.ModelSerializer):
     # 用__str__方法表示只读关系 items 为外键关系中的related_name
    items = serializers.StringRelatedField(many=True)

    class Meta:
        model = Category
        # fields = ('id', 'title','items')
        fields = "__all__"


    class CategoryPrimaryKeySerializer(serializers.ModelSerializer):
        # 用主键表示关系
        items = serializers.PrimaryKeyRelatedField(many=True, read_only=True)

        class Meta:
            model = Category
            fields = "__all__"


class CategorySlugSerializer(serializers.ModelSerializer):
    # 选取关系对象中任意一个字段(唯一标识)表示关系
    items = serializers.SlugRelatedField(
        many=True,
        read_only=True,
        slug_field='title'
    )

    class Meta:
        model = Category
        fields = "__all__"
要注意related_name要设置成items,外键关系和多对多关系都要设置related_name
items

2、在views.py导入三个类

from .serilaizes import UserFavSerializer, CategoryStringSerializer, \
CategoryPrimaryKeySerializer, CategorySlugSerializer


class CategoryStringitemsViewset(viewsets.ReadOnlyModelViewSet):
    """
    list:
        分类列表数据
    retrieve:
        获取分类详情
    """
    # 查询对象集
    queryset = Category.objects.all()
    # 序列化的类名
    serializer_class = CategoryStringSerializer
    lookup_field = "id"


class CategoryPrimaryKeyitemsViewset(viewsets.ReadOnlyModelViewSet):
    """
    list:
        分类列表数据
    retrieve:
        获取分类详情
    """
    # 查询对象集
    queryset = Category.objects.all()
    # 序列化的类名
    serializer_class = CategoryPrimaryKeySerializer
    lookup_field = "id"


class CategorySlugitemsViewset(viewsets.ReadOnlyModelViewSet):
    """
    list:
        分类列表数据
    retrieve:
        获取分类详情
    """
    # 查询对象集
    queryset = Category.objects.all()
    # 序列化的类名
    serializer_class = CategorySlugSerializer
    lookup_field = "id"

3、将三个类注册到我们的urls.py中

router.register(r'categoryStringitems', view.CategoryStringitemsViewset, base_name='categoryStringitems')
router.register(r'categoryPrimaryKeyitems', view.CategoryPrimaryKeyitemsViewset, base_name='categoryPrimaryKeyitems')
router.register(r'categorySlugitems', view.CategorySlugitemsViewset, base_name='categorySlugitems')

4、刷新页面,查看结果


新增三个API
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,255评论 4 61
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,145评论 1 32
  • 写技术博客变得越来越普及了,自上次华为面试落败后,我想了很多,技术这件事需要不停的巩固复习,多写多练才对,基础很重...
    米纳斯少校阅读 1,392评论 0 1
  • 中国有成语“覆水难收”,意思是“倒在地上的水难以收回”,比喻事情已成定局,难以挽回。英文中的“it's no us...
    玲玲A阅读 19,703评论 0 1
  • 曼陀罗花 一层又一层,一圈又一圈 把心事深藏 只露出绚烂的外表 1,铅笔画出米字格,这一步相当重要,不要省略哦!几...
    语静然阅读 356评论 0 7