drf - viewset (2)

ViewSet 主要是用来解决 APIView 中,要求 函数名必须是请求名的问题

在 ViewSet 可以用任意的函数作为 请求的 函数,只需要在
定义路由的时候,在 as_view 中,指定 请求方法 和 函数 的对应关系即可
还解决了 在同一类中,只能定义 一个 get 请求方法

class  UserViewSet(ViewSet):
  
	def list(self, request):
		# 查询所有数据
		pass
		
	def create(self, request):
		# 新增数据
		pass

定义路由:

path('users', views.UserViewSet.as_view({"get":"list", "post":"create" }))

混合视图

from rest_framework.mixins import -ListModelMixin, CreateModelMixin , RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin

  • ListModelMixin
  • CreateModelMixin
  • RetrieveModelMixin
  • UpdateModelMixin
  • DestroyModelMixin

混合视图 内置了一系列的方法,例如 list, create, retrieve, update, destroy

混合适合 需要 和 GenericViewSet 配合使用
代码示例:

class UserView(ListModelMixin, CreateModelMixin,
            RetrieveModelMixin, UpdateModelMixin,
			DestroyModelMixin,
               GenericViewSet):

    queryset = User.objects.all()
    serializer_class = UserSerializer

定义路由

path('users', views.UserView.as_view({"get":"list", "post":"create"}), name="user-list"),
url('users/(?P<pk>\d+$)', views.UserView.as_view({"get":"retrieve", "put": "update", "delete":"destroy"}), name="user-detail"),

在 ViewSet 中, 可以定义一个router,用来替代传统的路由定义
新建一个 routers.py ,代码如下

from rest_framework.routers import DefaultRouter

router = DefaultRouter()

router.register('user',  views.UserView)

在路由urls.py 中进行管理

from .routers import router 

urlpatterns = [
	url('^', include(router.urls))
	...
	...
]

router.urls 返回的结果如下格式:

[
	<URLPattern '^user/$' [name='user-list']>, 
	<URLPattern '^user\.(?P<format>[a-z0-9]+)/?$' [name='user-list']>, 
	<URLPattern '^user/(?P<pk>[^/.]+)/$' [name='user-detail']>, 
	<URLPattern '^user/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$' [name='user-detail']>, 
	<URLPattern '^$' [name='api-root']>, 
	<URLPattern '^\.(?P<format>[a-z0-9]+)/?$' [name='api-root']>
]

ViewSet 在使用的时候

get : 默认对应 list , retrieve
post : 默认对应create
put : 默认对应update
delete :默认对应 destory

在 ViewSet 中, 自定义一个函数、如何让 DefaultRouter 识别

在 ViewSet 中, 通过 一个 @action 装饰器,装饰某个函数,就可以让 DefaultRouter识别

@action 装饰中,常见的属性有:

  • methods : 代表请求方式、是一个列表,可以设置多个
  • detail : True/False : True在路由上会设置一个 pk,要求根据 主键进行数据查询,False则和主键没有关系
  • url_path : 设置请求路径 , 相当于 path函数中 router
  • url_name : 设置请求路由对应的名字,相当于 path函数中 name
detail=False
<URLPattern '^user/login/$' [name='user-login']>,
detail=True
<URLPattern '^user/(?P<pk>[^/.]+)/login/$' [name='user-login']>, 

ModelViewSet / ReadOnlyModelViewSet

ModelViewSet 继承了
mixins.CreateModelMixin,
mixins.RetrieveModelMixin,
mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
mixins.ListModelMixin,
GenericViewSet

ReadOnlyModelViewSet 继承了
mixins.RetrieveModelMixin,
mixins.ListModelMixin,
GenericViewSet

### 解决 `drf-spectacular` 中 "no operations defined in spec" 错误 当遇到 `drf-spectacular` 生成的 OpenAPI 文档中没有任何操作被定义的情况时,这通常是由于视图函数或类未正确配置所致。以下是几种常见的原因及其解决方案: #### 1. 视图装饰器缺失 如果使用的是基于函数的视图,则需要确保已应用适当的装饰器来标记这些视图作为 API 端点。 ```python from rest_framework.decorators import api_view, permission_classes from drf_spectacular.utils import extend_schema @extend_schema(request=None, responses={200: None}) @api_view(['GET']) def my_api_view(request): ... ``` 对于基于类的视图 (APIView 或者 ViewSet),应该继承自相应的基类并利用扩展模式工具提供的辅助方法[^1]。 #### 2. URL 路由注册不完全 确认所有的路由都已经被正确地添加到了项目的主 urls.py 文件里,并且每个路径都有对应的视图处理程序关联起来。例如: ```python urlpatterns = [ path('api/v1/', include(('myapp.urls', 'myapp'), namespace='v1')), ] ``` 另外,在子模块内的 urls.py 中也要保证有合适的入口指向具体的资源接口[^3]。 #### 3. 设置项验证 检查 settings.py 中有关 SPECTACULAR_SETTINGS 的部分是否有遗漏的关键字参数。特别是要留意 SERVE_PERMISSIONS 和 AUTHENTICATION_CLASSES 这两个属性是否已经按照实际环境的要求进行了适当设定。 #### 4. 使用默认分页器或其他全局中间件影响 有时某些全局作用域下的组件(如分页器)会干扰到 schema 自动生成逻辑。可以考虑暂时移除它们看看问题能否得到改善;如果是这样,就需要进一步调查如何让两者共存而不冲突了[^2]。 通过以上几个方面逐一排查,应当能够找到造成 “no operations defined in spec” 报错的根本原因,并采取相应措施加以修正。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值