什么是视图集?视图集是 DRF 提供的用于统一管理多个相关视图逻辑的类。...:DRF 的路由器通过预定义的规则(如 list 对应 GET /users/),结合视图集的方法检测,动态生成 URL。...其他视图集的使用场景GenericViewSet使用场景适用场景:需要灵活组合 Mixin 的场景(如仅支持部分操作)。...ReadOnlyModelViewSet使用场景适用场景:只读接口(如公开的数据查询 API)。...视图集中 @action 装饰器的使用@action 是 DRF 中用于在视图集(ViewSet)中定义自定义动作的核心装饰器,可以将任意方法暴露为 API 端点。下面通过更多场景详细说明其用法。
Django REST Framework(以下简称DRF)是基于Django框架构建的Web API框架。...在DRF中,路由器(Router)是一个非常有用的工具,可以帮助我们轻松地定义API的路由,实现快速、可维护的API开发。一、路由器的作用在DRF中,路由器的主要作用是将URL和视图函数绑定在一起。...路由器可以根据视图函数的名称和参数,自动生成URL,并将请求分发到对应的视图函数中。使用路由器可以避免手动编写URL配置的繁琐和容易出错。二、路由器的使用安装DRF在使用路由器之前,需要先安装DRF。...(1)基于视图集在DRF中,视图集是一组视图函数的集合,可以实现类似于CRUD的操作。.../books/{id}/destroy(2)基于视图除了视图集,我们也可以使用基于视图的方式来注册视图函数。
DRF框架学习(四) 1.视图集对象的action属性 作用: 获取现在要执行的是哪一种操作。 self.action:是字符串类型,目的是获取所有执行的操作。...返回latest操作所使用的查询集 else: # 返回其他操作所使用的查询集 2.路由Router(urls文件中使用) 作用:(重点) 配合视图集进行使用,动态生成视图集中处理函数的...urlpatterns += router.urls 注意点: 指定Router生成视图集处理函数url配置项时,提取的参数正则表达式。...lookup_value_regex = '\d+' 2.1视图集额外处理方法url配置项的生成 需要给对应的方法添加action装饰器。...在执行视图的dispatch()方法前,会先进行视图访问权限的判断 在通过get_object()获取具体对象时,会进行对象访问权限的判断 DRF框架提供了四个权限控制类: AllowAny允许所有用户
可以看到内容大体上是正确的,接口基本上都罗列了出来,但是仔细检查各个接口的内容,就会发现一些问题: GET /api-version/test/ 这个接口是我们用来测试的,不希望它显示在文档里。...多出一个 GET /search/{id}/ 接口,这个接口我们并不需要其被使用,因此也无需在文档列出。...对于 GET /api-version/test/ 这个接口,它对应的视图集是 ApiVersionTestViewSet,给这个视图集添加一个 swagger_schema 类属性,将值设为 None...例如我们可以看到 GET /posts/{id}/ 这个接口的响应参数,其中大部分有中文信息的描述,我们可以推断,这些说明都是 drf-yasg 自动从定义在 Post 模型各字段的 verbose_name...,但在全局进行了配置),在解析 list_archive_dates 的参数时,drf-yasg 错误地解析到了从视图集继承来的 PostFilter 和 PageNumberPagination,所以就把这两个类中定义的参数也包含进文档了
Django REST Framework (DRF) 是一个开源的 Web 框架,它建立在 Django 上,可以帮助你轻松地构建 RESTful API。...DRF 提供了很多有用的功能,其中之一就是过滤器(filters)。过滤器是一种机制,它可以让你在获取资源时对它们进行过滤。在 DRF 中,你可以使用内置的过滤器或者编写自定义的过滤器。...例如,如果我们要获取价格在 10 到 20 之间的书籍,我们可以使用 URL http://localhost:8000/api/books/?...filter_backends 属性中,以便它可以在视图集合中使用。...我们还展示了如何在视图集合中使用这些过滤器,并提供了一些例子来帮助你更好地理解它们的用法。
定制视图集操作视图集提供了一些通用的操作,例如获取列表、创建对象、获取详情、更新对象、部分更新对象和删除对象等。如果需要定制这些操作的行为,可以在视图集中重写对应的方法。...例如,在 BookViewSet 中,我们可以定制 create() 方法,以便在创建新书籍时自动将当前用户设置为书籍的作者:class BookViewSet(viewsets.ModelViewSet...我们使用 self.request.user 获取当前请求的用户,并将其设置为新书籍的作者。...我们使用 self.request.user 获取当前请求的用户,并将其用于过滤书籍列表,只返回当前用户的书籍。视图集类型DRF 中提供了多种视图集类型,可以根据不同的需求选择合适的视图集类型。...ViewSet: 不提供任何操作,需要手动在子类中定义操作方法。视图集类型的选择取决于 API 的需求和开发人员的编写习惯。
、类视图、视图集合到自动生成 API,满足各种需要; 多种身份认证和权限认证方式的支持; 内置了限流系统; 直观的 API web 界面; 可扩展性,插件丰富 重点掌握: 序列化器、类视图、Mixin扩展类...3.2见识DRF的魅力 我们仍以在学习Django框架时使用的图书英雄为案例,使用Django REST framework快速实现图书的REST API。 3.2.1....ModelViewSet): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer queryset 指明该视图集在查询数据时使用的查询集...:DRF框架中所有序列化器的父类,定义序列化器类时,可以直接继承此类 # serializers.ModelSerializer:是Serializer的子类,在父类基础上,添加了一些功能 class...,将要被反序列化的数据传入data参数 3)除了instance和data参数外,在构造Serializer对象时,还可通过context参数额外添加数据,如 serializer = AccountSerializer
添加rest_framework应用 我们利用在Django框架学习中创建的demo工程,在settings.py的INSTALLED_APPS中添加'rest_framework'。 ?...ModelViewSet): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer queryset 指明该视图集在查询数据时使用的查询集...serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器 3....运行测试 python manage.py runserver 在浏览器中输入网址127.0.0.1:8000,可以看到DRF提供的API Web浏览页面: ?...3)在浏览器中输入网址127.0.0.1:8000/books/1/,可以访问获取单一图书信息的接口(id为1的图书),呈现如下页面: ?
2. related_name related_name是在定义模型类时,外键的一个选项。它的功能下面慢慢给大家分析一下。...,我们还可以补充额外的验证: a.先写一个函数(如about_django)封装补充验证的功能,然后在字段中添加 validators参数,如下: btitle = serializers.CharField...5.5.2视图基类 5.5.2.1APIView 是View类的子类,在View类的基础上添加了一些额外的功能。...5.6视图集 5.6.1概念 将操作同一组资源的处理方法(API接口)放在同一个类中 5.6.2注意点 1.视图集中的处理方法不再以请求方法命名,而是以对应的操作(action)名称命名:list/create...5.6.4视图集中添加额外的处理方法 1.直接在视图集定义额外的处理方法即可 2.在进行url配置的时候也要指定请求地址请求方式和处理函数之间的对应的关系。
DRF视图集 我们在三级视图中,由于获取所有数据和获取一条数据都是使用GET请求,而二级视图(三级视图)只允许有一个get方法,因此我们在两个类中进行了设计,并且这样刚好将路由分开。...ViewSet 该类继承自APIView,我们可以使用任何标准属性(如permission_classes,authentication_classes)来控制视图集上的API。...这对于简单的场景是非常实用的,我们可以只提供queryset,serializer_class,pagination_class等属性即可。同时DRF提供了适用于视图集的路由来方便使用。...但是目前的路由依旧不是让我们很满意。好在DRF提供了给视图集使用的路由方式。...DRF的路由,效果是一样的,如下所示:
一、常见面试问题核心组件与工作流程视图(Views):解释视图在DRF中的作用,介绍基于类的视图(ViewSet、GenericViewSet)与视图集(ViewSets)的概念,以及如何关联到URL。...版本控制:讨论DRF中实现API版本控制的方法,如URL路径版本、请求头版本等。...异常处理:介绍如何使用DRF的异常体系(如PermissionDenied、NotAuthenticated、ValidationError等)处理错误情况,并自定义异常响应。...对于复杂查询,考虑使用Django ORM的查询优化技巧或添加数据库索引。...、规避常见错误,并通过实战项目积累经验,将有助于你在Python面试中展现优秀的API开发技能,从容应对DRF相关的问题挑战。
并且在查询出数据,返回结果之前,先将查询的结果存到缓存中,便于下次使用。 2.2使用缓存 在Django REST framework中使用缓存,可以通过 drf-extensions扩展来实现。...2.2.1安装 pip install drf-extensions 2.2.2使用方法 直接添加装饰器 可以在使用restframeworkextensions.cache.decorators中的cache_response...缓存后端(即CACHES配置中的键名称) 如果在使用cache_response装饰器时未指明timeout或者cache参数,则会使用配置文件中的默认配置,可以通过如下方法指明: # DRF扩展 REST_FRAMEWORK_EXTENSIONS...2.2.3为省市区视图添加缓存 因为省市区视图使用了视图集,并且视图集中有提供ListModelMixin和RetrieveModelMixin的扩展(由ReadOnlyModelViewSet提供),...除了instance和data参数外,在构造Serializer对象时,还可通过context参数额外添加数据,如 serializer = AccountSerializer(account, context
前言 使用视图集ViewSet,可以将一系列逻辑相关的动作放到一个类中: list() 提供一组数据 retrieve() 提供单个数据 create() 创建数据 update() 保存数据...视图集只在使用as_view()方法的时候,才会将action动作与具体请求方式对应上。...ViewSet主要通过继承ViewSetMixin来实现在调用as_view()时传入字典(如{‘get’:‘list’})的映射处理工作。...GenericViewSet就帮助我们完成了这样的继承工作,继承自GenericAPIView与ViewSetMixin,在实现了调用as_view()时传入字典(如{‘get’:‘list’})的映射处理工作的同时..."""经过上面的处理,我们就已经把所有视图方法写在一个类中了,但是继承父类有点多 所以,drf里面提供了模型视图集[ModelViewSet],可以一次性提供5个api接口的方法 最后,def还提供了只读模型视图集
回顾一下我们之前在使用视图集 viewset 时提到过 action(动作)的概念,django-rest-framework 预定义了几个标准的动作,分别为 list 获取资源列表,retrieve...django-rest-framework 默认只能识别标准命名的视图集方法并将其注册为 API,但我们可以添加更多非标准的 action,而为了让 django-rest-framework 能够识别这些方法...action 装饰器通常用于在视图集中添加额外的接口实现。例如这里我们已有了 PostViewSet 视图集,标准的 list 实现了获取文章资源列表的逻辑。...通常如果要在视图集中添加额外的接口实现,可以使用如下的模板代码: @action( methods=["allowed http method name"], detail=False...现在,侧边栏所需要的数据接口就开发完成了,接下来实现返回某一分类、标签或者归档日期下的文章列表接口。 在 使用视图集简化代码 我们开发了获取全部文章的接口。
DRF自动生成OpenAPI文档 API schemas是非常有用的,可以帮助我们生成接口文档以及可与API交互的动态客户端。...在这里我们使用drf-spectacular这个第三方库来自动生成OpenAPI schemas. drf-spectacular 安装,配置步骤可以参考drf-spectacular文档,下面简单的给出步骤...安装和配置 使用 经过上面的基本配置,我们现在访问api/schema/swagger-ui/来查看swagger-ui风格的文档,如下所示: 当你点击schema的时候,就会显示响应字段的描述...在视图集中使用 对于视图集而言,可以使用@extend_schema_view装饰器来直接装饰类。..., extend_schema_view, OpenApiTypes 关于更多的使用方法,请参考文档
可以在rest_framework.settings 查找所有的drf默认配置项。其中配置响应格式的配置项为: ? 在局部配置使用,即只对某一个视图类配置生效。...在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。例如使用APIView简单的实现五个增删查改的API接口。...视图集只在使用as_view()方法的时候,才会将action 动作与具体请求方式对应上。...GenericViewSet就帮助我们完成了这样的继承工作,继承自GenericAPIView与ViewSetMixin,在实现了调用as_view()时传入字典(如{'get':'list'})的映射处理工作的同时...3.2 action 在视图集中,我们可以通过action对象属性来获取当前请求视图集时的action动作是哪个。除了默认的方法动作外,还可以添加自定义动作。
如何使用视图集定义视图集定义视图集需要继承 DRF 提供的视图集类,例如 ModelViewSet:from rest_framework import viewsetsfrom .models import...注册视图集接下来,需要将定义好的视图集注册到路由中。我们可以使用 DRF 提供的 DefaultRouter 类来帮助我们自动生成 URL 配置。...然后,我们创建了一个路由对象 router,并使用 router.register() 方法将 BookViewSet 视图集注册到路由中。...r'books' 是 URL 的前缀,最终 URL 为 /books/、/books/{id}/ 等。...最后,我们将 router.urls 包含在 Django 的 URLConf 中,以便让 Django 可以将其添加到项目的 URL 配置中。
在 Web 应用程序中,当我们从数据库中检索大量数据时,为了避免一次性返回所有数据,通常需要将数据分成多个页面。这就是分页的基本概念:将数据分成多个页面,每个页面包含一定数量的数据。...在 Django REST Framework(DRF)中,分页是指将 API 查询结果划分为多个页面,每个页面包含一定数量的对象,以便在不降低性能和效率的情况下处理大量数据。...分页器DRF 提供了多种分页器,可以根据不同的需求进行选择。分页器可以在视图集合中使用,以将查询结果分成多个页面,并将每个页面的数据返回给客户端。...我们还为客户端指定了可以在查询参数中使用的 page_size 参数,并设置了最大页面大小为 100。最后,我们将 BookPagination 分页器类添加到 BookViewSet 视图集合中。...现在,当客户端发起请求时,我们的 BookViewSet 视图集合将使用 BookPagination 分页器将查询结果划分为多个页面,并将每个页面的数据返回给客户端。
定制URL前缀在路由器注册视图函数时,可以使用prefix参数来定制URL的前缀。...定制URL后缀在路由器注册视图函数时,还可以使用suffix参数来定制URL的后缀。...定制视图函数名称在路由器注册视图函数时,可以使用basename参数来定制视图函数名称。...四、总结本文介绍了DRF的路由器(Router)的作用、使用方法和高级用法,并给出了一些示例。路由器是DRF中非常重要的工具,可以帮助我们轻松地定义API的路由,实现快速、可维护的API开发。...如果您正在使用DRF进行API开发,那么路由器一定是您不可或缺的工具之一。
GenericAPIView 是 Django REST Framework (DRF) 中的一个基础视图类,它继承自 APIView,并添加了一些常用的功能,特别是与数据库模型交互的功能。...它是 DRF 中通用视图和视图集的基础,提供了查询、序列化、分页等常用操作的标准实现。本质上它是 DRF 中所有通用视图(如 ListAPIView、RetrieveAPIView 等)的基础。二....DRF 生态系统集成 - 与 DRF 的其他组件(如序列化器、权限等)无缝协作三....())通过合理使用这些功能,可以大大简化 API 开发工作,提高代码的可维护性和可读性。...同时,GenericAPIView 也是 DRF 中更高级视图(如 ListAPIView、RetrieveAPIView 等)的基础。