Django-APIView


前言

APIView解决了一些之前的问题,例如认证授权功能,限流功能,传递参数的形式单一等问题。

一、接收不同类型的参数

修改views.py中的代码。使视图类继承APIView(APIView是View的子类)。
使用View视图我们接收到的request就是WSGIRequest对象或者HTTPRequest对象,但是使用APIView视图我们接收到的request就是Request对象。

# 需继承APIView
#class ProjectViews(View):
class ProjectViews(APIView):
    ...
  • 1.1-1.4其实可以不看,直接看1.5。

1.1 json参数获取

此时想要取json参数就可以使用request.data来获取,而且不用像View视图那样还得转换,这里我们取到的结果直接就是dict格式。
在这里插入图片描述

在这里插入图片描述

1.2 x-www-form-urlencoded参数获取

此参数即可通过request.data获取,又可以兼容之前的request.POST方式获取。
在这里插入图片描述

在这里插入图片描述

1.3 form-data参数获取

此参数即可通过request.data获取,又可以兼容之前的request.POST方式获取。
在这里插入图片描述
在这里插入图片描述

1.4 query string参数获取

此参数即可通过request.query_params获取,又可以兼容之前的request.GET方式获取。

在这里插入图片描述在这里插入图片描述

1.5 总结

不难发现,APIView视图获取参数时,query string参数使用request.query_params获取,其他参数都使用request.data获取,并且都兼容之前的获取参数的方式。

二、返回Response

APIView必须返回Response对象,Response拓展了HttpResponse。

class ProjectViews(APIView):
	def get(self, request: Request):
        ...
        # return JsonResponse(serializer.data, safe=False, json_dumps_params={"ensure_ascii": False})
        # 第一个参数为Python中的常用数据类(字典或者嵌套字典的列表),serializer.data;status参数用于传递响应状态码
        # c.Response对象.data属性,可以获取返回给前端的数据
        # res = Response(serializer.data, status=status.HTTP_200_OK)
        return Response(serializer.data, status=status.HTTP_200_OK)
  • 第一个参数为Python中的常用数据类(字典或者嵌套字典的列表),serializer.data
  • status参数用于传递响应状态码
    • status.HTTP_200_OK等同于200,使用status的属性是的返回状态码更加易读
  • Response对象.data属性,可以获取返回给前端的数据

三、过滤

修改view.py文件实现过滤

class ProjectViews(APIView):
    def get(self, request: Request):
        qs = Projects.objects.all()
        # 获取过滤的参数
        name = request.query_params.get('name')
        # 判断是否需要过滤
        if name:
        	# 过滤出name为前端传来的name的数据
            qs = qs.filter(name__exact=request.query_params.get('name'))
        serializer = serializers.ProjectModelSerializer(instance=queryset, many=True)
        return Response(serializer.data, status=status.HTTP_200_OK)

四、提取

我们的代码中重复用到Projects.objects.all()的查询集和serializers.ProjectModelSerializer序列化器类,我们可以把他们抽取出来,便于管理。

class ProjectViews(APIView):
    queryset = Projects.objects.all()
    serializer_class = serializers.ProjectModelSerializer
    
    def get(self, request: Request):
    	...

总结

这里的过滤功能感觉不是很好用,我们可以试试GenericAPIView视图。

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
1. 安装Elasticsearch和Python Elasticsearch客户端 - Elasticsearch安装可以参考官网的[安装文档](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html) - Python Elasticsearch客户端可以使用pip安装:`pip install elasticsearch` 2. 在Django项目中创建一个app,用于处理与Elasticsearch相关的逻辑。 3. 配置Elasticsearch连接信息,可以在Django的`settings.py`中添加以下配置: ``` ELASTICSEARCH_DSL = { 'default': { 'hosts': 'localhost:9200' }, } ``` 其中,`hosts`就是Elasticsearch的地址,这里使用默认的`localhost:9200`。 4. 创建Elasticsearch索引模板,可以在app目录下创建一个`search_indexes.py`文件,定义索引模板: ``` from elasticsearch_dsl import Document, Text, Date, Keyword class ArticleIndex(Document): title = Text() content = Text() pub_date = Date() tags = Keyword(multi=True) class Index: name = 'articles' ``` 其中,`ArticleIndex`是一个继承自`Document`的类,定义了索引的字段和类型。`Index`类中的`name`属性指定了索引的名称。 5. 在app目录下创建`serializers.py`文件,定义序列化器,将模型序列化为Elasticsearch索引模板: ``` from rest_framework import serializers from .models import Article from .search_indexes import ArticleIndex class ArticleIndexSerializer(serializers.ModelSerializer): class Meta: model = Article fields = ('id', 'title', 'content', 'pub_date', 'tags') def save(self, **kwargs): article = super().save(**kwargs) article_index = ArticleIndex(meta={'id': article.id}, **article.__dict__) article_index.save() return article ``` 其中,`ArticleIndexSerializer`继承自`ModelSerializer`,定义了序列化的模型和字段。在`save`方法中,先保存模型,再将模型数据序列化为Elasticsearch索引模板,最后保存到Elasticsearch中。 6. 在app目录下创建`views.py`文件,定义视图函数,实现Elasticsearch搜索功能: ``` from rest_framework.views import APIView from rest_framework.response import Response from elasticsearch_dsl import Q from .search_indexes import ArticleIndex from .serializers import ArticleIndexSerializer class ArticleSearchView(APIView): def get(self, request): query = request.query_params.get('q', '') s = ArticleIndex.search().query( Q('multi_match', query=query, fields=['title', 'content', 'tags']) ) response = [] for hit in s.execute().hits: serializer = ArticleIndexSerializer(data=hit.to_dict()) serializer.is_valid() response.append(serializer.data) return Response(response) ``` 其中,`ArticleSearchView`继承自`APIView`,定义了一个`get`方法,接收`q`参数作为搜索关键词。通过Elasticsearch DSL构建查询语句,搜索索引模板中的数据,最后将搜索结果序列化返回。 7. 在app目录下创建`urls.py`文件,定义路由: ``` from django.urls import path from .views import ArticleSearchView urlpatterns = [ path('search/', ArticleSearchView.as_view(), name='article_search'), ] ``` 其中,`search`路由对应了`ArticleSearchView`视图函数。 8. 在Django的`settings.py`中添加app,配置数据库信息: ``` INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'rest_framework', 'app_name', # 添加app ] DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'NAME': 'db_name', 'USER': 'db_user', 'PASSWORD': 'db_password', 'HOST': 'localhost', 'PORT': '3306', } } ``` 9. 在app目录下创建`models.py`文件,定义模型,使用Django ORM作为数据源: ``` from django.db import models class Article(models.Model): title = models.CharField(max_length=255) content = models.TextField() pub_date = models.DateTimeField(auto_now_add=True) tags = models.CharField(max_length=255, blank=True) def __str__(self): return self.title ``` 其中,`Article`是一个继承自`models.Model`的类,定义了文章的属性。 10. 在app目录下创建`admin.py`文件,注册模型到Django Admin中: ``` from django.contrib import admin from .models import Article admin.site.register(Article) ``` 11. 在Django的`urls.py`中添加app的路由: ``` from django.contrib import admin from django.urls import path, include urlpatterns = [ path('admin/', admin.site.urls), path('api/', include('app_name.urls')), ] ``` 12. 启动Django开发服务器,访问`http://localhost:8000/admin/`,进入Django Admin,创建一些文章数据。 13. 访问`http://localhost:8000/api/search/?q=django`,可以看到搜索结果,其中包含关键词`django`的文章数据。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值