Step8: 实现分类、标签、归档日期接口

Author: zmrenwu

README.md

@@ -196,6 +196,7 @@ $ git clone https://github.com/HelloGitHub-Team/HelloDjango-REST-framework-tutor
 7. [分页](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/96/)
 8. [文章详情 API](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/97/)
 9. [在接口返回Markdown解析后的内容](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/98/)
+10. [实现分类、标签、归档日期接口](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/99/)
 
 ## 公众号
 <p align="center">

blog/filters.py

@@ -0,0 +1,16 @@
+from django_filters import rest_framework as drf_filters
+
+from .models import Post
+
+
+class PostFilter(drf_filters.FilterSet):
+    created_year = drf_filters.NumberFilter(
+        field_name="created_time", lookup_expr="year"
+    )
+    created_month = drf_filters.NumberFilter(
+        field_name="created_time", lookup_expr="month"
+    )
+
+    class Meta:
+        model = Post
+        fields = ["category", "tags", "created_year", "created_month"]

blog/urls.py

@@ -11,6 +11,4 @@
     ),
     path("categories/<int:pk>/", views.CategoryView.as_view(), name="category"),
     path("tags/<int:pk>/", views.TagView.as_view(), name="tag"),
-    # path("api/index/", views.IndexPostListAPIView.as_view()),
-    path("api/index/", views.index),
 ]

blog/views.py

@@ -1,18 +1,25 @@
-from django.contrib import messages
-from django.db.models import Q
-from django.shortcuts import get_object_or_404, redirect, render
+from django.shortcuts import get_object_or_404
 from django.views.generic import DetailView, ListView
+from django_filters.rest_framework import DjangoFilterBackend
 from rest_framework import mixins, status, viewsets
-from rest_framework.decorators import api_view
+from rest_framework.decorators import action
 from rest_framework.generics import ListAPIView
 from rest_framework.pagination import PageNumberPagination
 from rest_framework.permissions import AllowAny
 from rest_framework.response import Response
+from rest_framework.serializers import DateField
+from rest_framework.views import APIView
 
 from pure_pagination.mixins import PaginationMixin
 
+from .filters import PostFilter
 from .models import Category, Post, Tag
-from .serializers import PostListSerializer, PostRetrieveSerializer
+from .serializers import (
+    CategorySerializer,
+    PostListSerializer,
+    PostRetrieveSerializer,
+    TagSerializer,
+)
 
 
 class IndexView(PaginationMixin, ListView):
@@ -84,11 +91,40 @@ class PostViewSet(
         "list": PostListSerializer,
         "retrieve": PostRetrieveSerializer,
     }
+    filter_backends = [DjangoFilterBackend]
+    filterset_class = PostFilter
 
     def get_serializer_class(self):
         return self.serializer_class_table.get(
             self.action, super().get_serializer_class()
         )
 
+    @action(
+        methods=["GET"], detail=False, url_path="archive/dates", url_name="archive-date"
+    )
+    def list_archive_dates(self, request, *args, **kwargs):
+        dates = Post.objects.dates("created_time", "month", order="DESC")
+        date_field = DateField()
+        data = [date_field.to_representation(date) for date in dates]
+        return Response(data=data, status=status.HTTP_200_OK)
+
 
 index = PostViewSet.as_view({"get": "list"})
+
+
+class CategoryViewSet(mixins.ListModelMixin, viewsets.GenericViewSet):
+    serializer_class = CategorySerializer
+    # 关闭分页
+    pagination_class = None
+
+    def get_queryset(self):
+        return Category.objects.all().order_by("name")
+
+
+class TagViewSet(mixins.ListModelMixin, viewsets.GenericViewSet):
+    serializer_class = TagSerializer
+    # 关闭分页
+    pagination_class = None
+
+    def get_queryset(self):
+        return Tag.objects.all().order_by("name")

blogproject/settings/common.py

@@ -32,6 +32,7 @@
     "pure_pagination",  # 分页
     "haystack",  # 搜索
     "rest_framework",
+    "django_filters",
     "blog.apps.BlogConfig",  # 注册 blog 应用
     "comments.apps.CommentsConfig",  # 注册 comments 应用
 ]

blogproject/urls.py

@@ -22,6 +22,8 @@
 
 router = routers.DefaultRouter()
 router.register(r"posts", blog.views.PostViewSet, basename="post")
+router.register(r"categories", blog.views.CategoryViewSet, basename="category")
+router.register(r"tags", blog.views.TagViewSet, basename="tag")
 
 urlpatterns = [
     path("admin/", admin.site.urls),