Step10: 基于 drf-haystack 实现文章搜索接口

Author: zmrenwu

Pipfile

@@ -17,6 +17,7 @@ elasticsearch = ">=2,<3"
 django-haystack = "*"
 djangorestframework = "*"
 django-filter = "*"
+drf-haystack = "*"
 
 [requires]
 python_version = "3"

Pipfile.lock

@@ -197,7 +197,8 @@ $ git clone https://github.com/HelloGitHub-Team/HelloDjango-REST-framework-tutor
 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/)
-11. [评论接口](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/100/)
+11. [评论接口](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/100/))
+12. [基于 drf-haystack 实现文章搜索接口](https://www.zmrenwu.com/courses/django-rest-framework-tutorial/materials/101/))
 
 ## 公众号
 <p align="center">

README.md

@@ -1,7 +1,16 @@
 from django.contrib.auth.models import User
 from rest_framework import serializers
+from rest_framework.fields import CharField
+
+from drf_haystack.serializers import (
+    HaystackSerializer,
+    HaystackSerializerMixin,
+    HighlighterMixin,
+)
 
 from .models import Category, Post, Tag
+from .search_indexes import PostIndex
+from .utils import Highlighter
 
 
 class CategorySerializer(serializers.ModelSerializer):
@@ -71,3 +80,30 @@ class Meta:
             "toc",
             "body_html",
         ]
+
+
+class HighlightedCharField(CharField):
+    def to_representation(self, value):
+        value = super().to_representation(value)
+        request = self.context["request"]
+        query = request.query_params["text"]
+        highlighter = Highlighter(query)
+        return highlighter.highlight(value)
+
+
+class PostHaystackSerializer(HaystackSerializerMixin, PostListSerializer):
+    title = HighlightedCharField()
+    summary = HighlightedCharField(source="body")
+
+    class Meta(PostListSerializer.Meta):
+        search_fields = ["text"]
+        fields = [
+            "id",
+            "title",
+            "summary",
+            "created_time",
+            "excerpt",
+            "category",
+            "author",
+            "views",
+        ]

blog/serializers.py

@@ -11,12 +11,15 @@
 from rest_framework.views import APIView
 
 from comments.serializers import CommentSerializer
+from drf_haystack.viewsets import HaystackViewSet
 from pure_pagination.mixins import PaginationMixin
 
 from .filters import PostFilter
 from .models import Category, Post, Tag
+from .search_indexes import PostIndex
 from .serializers import (
     CategorySerializer,
+    PostHaystackSerializer,
     PostListSerializer,
     PostRetrieveSerializer,
     TagSerializer,
@@ -149,3 +152,8 @@ class TagViewSet(mixins.ListModelMixin, viewsets.GenericViewSet):
 
     def get_queryset(self):
         return Tag.objects.all().order_by("name")
+
+
+class PostSearchView(HaystackViewSet):
+    index_models = [Post]
+    serializer_class = PostHaystackSerializer

blog/views.py

@@ -7,4 +7,4 @@
 ALLOWED_HOSTS = ['*']
 
 # 搜索设置
-HAYSTACK_CONNECTIONS['default']['URL'] = 'http://elasticsearch_local:9200/'
+HAYSTACK_CONNECTIONS['default']['URL'] = 'http://elasticsearch.local:9200/'

blogproject/settings/local.py

@@ -26,6 +26,7 @@
 router.register(r"categories", blog.views.CategoryViewSet, basename="category")
 router.register(r"tags", blog.views.TagViewSet, basename="tag")
 router.register(r"comments", comments.views.CommentViewSet, basename="comment")
+router.register(r"search", blog.views.PostSearchView, basename="search")
 
 urlpatterns = [
     path("admin/", admin.site.urls),