如何在drf_yasg中标记整个ViewSet？
在drf_yasg中标记整个ViewSet，可以通过使用装饰器@swagger_auto_schema来实现。该装饰器可以应用于ViewSet类的方法上，用于自定义API文档的展示。
要标记整个ViewSet，可以在ViewSet类上使用@swagger_auto_schema装饰器，并传入auto_schema=None参数。这样可以将默认的自动化文档生成过程禁用，只保留手动编写的文档信息。
以下是一个示例代码：
from drf_yasg.utils import swagger_auto_schema
@swagger_auto_schema(auto_schema=None)
class MyViewSet(viewsets.ViewSet):
"""
这是一个示例ViewSet
"""
queryset = MyModel.objects.all()
serializer_class = MySerializer
@action(detail=True, methods=['get'])
def my_action(self, request, pk=None):
"""
这是一个自定义的action
"""
# 自定义逻辑...
def list(self, request):
"""
获取所有对象的列表
"""
# 自定义逻辑...
def create(self, request):
"""
创建一个新对象
"""
# 自定义逻辑...
def retrieve(self, request, pk=None):
"""
获取单个对象的详细信息
"""
# 自定义逻辑...
def update(self, request, pk=None):
"""
更新单个对象
"""
# 自定义逻辑...
def partial_update(self, request, pk=None):
"""
部分更新单个对象
"""
# 自定义逻辑...
def destroy(self, request, pk=None):
"""
删除单个对象
"""
# 自定义逻辑...在上述示例中，@swagger_auto_schema(auto_schema=None)装饰器应用于MyViewSet类，禁用了自动化文档生成过程。你可以根据实际需求，自定义每个方法的文档信息，包括描述、请求参数、响应体等。
请注意，这只是一个示例，你需要根据实际情况进行适当的修改和扩展。关于drf_yasg的更多详细信息和用法，请参考drf_yasg官方文档。
相关·内容
我有以下ViewSet： class AuthorViewSet(viewsets.ModelViewSet):
queryset = Author.objects.all()
serializer_class = AuthorSerializer
permission_classes = [permissions.AllowAny]
# note that no methods are overridden 我希望drf_yasg生成自定义模式，以便所有操作方法都被标记为Authors。 文档中说，我的选择是通过声明每个方法并使用@swagger_auto
浏览 91提问于2020-10-03得票数 2
回答已采纳
我是第一次整合drf-yasq的装腔作势，对不起！如果我的问题很傻的话。我从这里读到了文档，，并遵循说明，最后得到了AttributeError: 'Response' object has no attribute 'label'。原始代码来自。请在我缺少的地方帮助我：
终端：
Internal Server Error: /swagger/
Traceback (most recent call last):
File "/Users/admin/Desktop/food-delivery-app-19083590-python/env/lib
浏览 3提问于2019-12-12得票数 1
回答已采纳
是否有一种方法可以像在operation_id中显示drf_yasg那样在drf_spectacular中显示drf_yasg？文档没有显示有关此设置的任何内容。operation_id在我们的代码生成器中使用，所以在概述中查看它是非常实用的。
浏览 8提问于2022-11-01得票数 0
回答已采纳
ViewSet
class LoginAPI(generics.GenericAPIView):
serializer_class = LoginSerializer
def post(self, request):
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
user = serializer.validated_data
# Generate user token
浏览 3提问于2021-11-09得票数 2
有办法记录由Django REST框架(通过扩展ViewSet)自动生成的pk参数吗？
ViewSet中的示例函数：
class MyViewSet(viewsets.ViewSet):
@detail_route(url_path='mypath')
def myapi(self):
"""
first_param -- Param 1
"""
pass
如果我在YAML文档字符串中添加一个pk参数，就会得到一个副本。
浏览 1提问于2015-11-04得票数 2
回答已采纳
我不能将@action装饰器应用于标准views.Viewset子类中的create函数。
@action(detail=True) # This fails.
def create(self, request, pk=None):
return Response(etc...)
在其他方法上，添加这个装饰器可以让我很容易地在URL中使用<pk>创建URL。例如，我可以向POST发送一个http://main_url.com/do_something_to_user_with_id/7/请求，其中do_something_to_user_with_id是视图集中的一些随机函
浏览 1提问于2021-01-16得票数 0
回答已采纳
我使用redoc + drf_yasg来生成使用django-rest-framwork生成的api的文档。只要我添加一个入口点，它就能很好地工作，它在文档中显示得很好。
但是，我不知道如何在文档中添加在查询过程中可以提供的搜索参数。
例如，在list函数中，我可以传递两个可选参数，id和name：
class TechnicalDataViewSet(viewsets.ViewSet):
"""
A simple ViewSet for listing or retrieving machine.
"""
per
浏览 27提问于2021-06-09得票数 2
我已经在我的应用程序中成功地为某个特定的pagination_class实现了一个自定义pagination_class，但是我遇到了一些问题:为基本的ViewSet建立一个单独的自定义pagination_class。
下面是工作pagination_class和相关的ModelViewSet：
class Model1Pagination(PageNumberPagination):
page_size = 10
page_size_query_param = 'page_size'
max_page_size = 100
class Model1ViewSe
浏览 2提问于2017-03-15得票数 0
回答已采纳
有许多类似的问题，但每个问题似乎都是在不同的场景下处理问题的，或者所描述的解决方案似乎无法解决我的问题。基本上，，为什么我要得到这个403禁止的错误？
POST http://127.0.0.1:8000/api/hello-viewset/ 403 (Forbidden)
url是Django Rest Framework ( DRF )端点，我可以从浏览器访问它，并使用DRF发布文章。问题是，当我试图从我的javascript文件中使用Ajax发布时。请注意，我正在传递CSRFToken (如建议的)：
$.ajax({
type: "POST",
url:
浏览 0提问于2018-12-06得票数 0
回答已采纳
我在试着理解跑步循环。对此进行编码的最佳方法是哪种？
for (UIView *view in self.viewSet) {
dispatch_async(dispatch_get_main_queue(), ^{
[view removeFromSuperview];
});
}
或
dispatch_async(dispatch_get_main_queue(), ^{
for (UIView *view in self.viewSet) {
[view removeFromSuperview];
}
});
浏览 3提问于2016-03-22得票数 1
回答已采纳
假设我遵循Django Rest框架的ViewSet：
from django.contrib.auth import get_user_model
from rest_framework.viewsets import ViewSet
from rest_framework.response import Response
class SubscriptionViewSet(ViewSet):
def list(self, request):
data = {'user_count': get_user_model().objects.count(
浏览 0提问于2019-03-18得票数 1
回答已采纳
我使用drf_yasg作为swagger文档。当我在AWS应用程序后面发布我的DRF应用程序时，加载平衡器并将侦听器设置为侦听443 HTTPS并重定向到运行DRF的EC2时，swagger试图将请求发送到端点http://example.com/status，而不是https://example.com/status。这会创建一个Google错误：
swagger-ui-bundle.js:71 Mixed Content: The page at 'https://example.com/swagger#/status/status_list' was loaded ove
浏览 2提问于2019-09-19得票数 10
回答已采纳
我使用的是Django 1.10和django-rest-framework 3.5.3。我希望有一个通用的搜索查询:在许多字段上搜索值。我在文件上找到了。
我尝试将过滤器后端添加到ViewSet中，但似乎不起作用。包含所有对象的任何搜索查询响应。
ViewSet：
from rest_framework import filters
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all().order_by('-date_joined')
serializer_class
浏览 0提问于2016-12-18得票数 7
回答已采纳
1回答
我使用的是来自的项目模板。我正在测试我的序列化器和在我的应用程序拥有的每一个视图集的许可。我希望使用pytest中的参数化来减少需要为每个序列化器和视图集编写测试的行数。我有10个序列化器和视图集，我需要测试它有一个模式，如下图所示。
test_drf_viewsets.py
@pytest.mark.parametrize(
("app_url", "app_viewset", "serializer"),
[
(
"api:mv-signu
浏览 3提问于2022-02-23得票数 0
回答已采纳
1回答
如何在drf_yasg中处理排序？
我有一个视图：
class ContentView(ModelViewSet):
....
ordering_fields = ['price',]
但当我打开swagger时，我看不到这种可能性。
浏览 18提问于2020-02-07得票数 0
回答已采纳
我正在做一些从Django 1.11 --> 3.1.5的迁移工作 在之前的"rest_framework_swagger“中，我能够在url.py中完成swagger api分组 url(r'^api/v9/test_token1$',
api.test_token,
name='test_token'),
url(r'^api/v9/test_token2$',
api.test_token,
name='test_token'), 然后获取这个(注意它对v9进行分组)
浏览 116提问于2021-02-02得票数 0
回答已采纳
2回答
它是这样的，我一定是这样构建的，当kommmer在每次加载页面时将数据库+1发送到文章中时，
我做过这样的事：
int id = Convert.ToInt32(Request.QueryString["Id"]);
string viewSet = "1";
SqlConnection conn = new SqlConnection(ConfigurationManager.ConnectionStrings["ConnectionString"].ToString());
SqlCommand cmd = new
浏览 3提问于2014-11-12得票数 0
回答已采纳
我需要使用具有相同URL的多个ViewSets，其中需要根据请求报头逻辑动态地选择active ViewSet。Django rest框架允许您这样做，以便根据不同的urls注册视图集：
router.register(r"type_1", Type1ViewSet, basename="type_1")
router.register(r"type_2", Type2ViewSet, basename="type_2")
然而，在我的例子中，视图集非常相似。因此，我想在urls.py文件中这样做：
if request.head
浏览 2提问于2021-05-10得票数 0
我正在尝试从viewsets.ViewSet中的List方法访问当前用户。但我得到了AnonymousUser。 我已经试过了 class ReportViewSet(viewsets.ViewSet):
"""Shows purchase report group by day"""
def list(self, request, **kwargs):
print(self.request.user) 有没有办法从viewsets.ViewSet访问当前用户
浏览 10提问于2020-10-13得票数 0
回答已采纳
ViewSet、ModelViewSet和APIView的优势是什么？在django-rest框架文档中，不清楚，它没有说明何时使用ViewSet、ModelViewSet和APIView。我想要实现一个API，其中包含一个业务逻辑，一个很好的业务逻辑和数据处理，在这种情况下应该使用什么？我对路由器、和urlpatterns进行了大量的研究，并设法了解了一些，但我不理解视图中的哪一个。
浏览 1提问于2020-02-07得票数 5
回答已采纳
在我的项目中，我使用为django rest框架API实现了swagger。
我跟着drf的快速开始部分。当我点击/swagger取得AssertionError:复制参数找到。下面是我的代码和回溯。
urls.py
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
schema_view = get_schema_view(
openapi.Info(
title="Snippets API",
default_version='v1'
浏览 3提问于2020-07-03得票数 8
如何在全局设置中将默认权限类设置为IsAuthenticated时允许访问基本路由。
REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly',
# 'rest_framework.permissions.AllowAny',
'rest_framework.permissions.IsAuthenticate
浏览 1提问于2019-09-08得票数 1
根据django rest框架工作3.7，(viewsets.ViewSet)将为一组标准的创建/检索/更新/销毁样式操作提供路由
和
(viewsets.ModelViewSet)还将为一组标准的创建/检索/更新/销毁样式操作提供路由
那么，何时使用这两个类，这两个类之间的区别是什么。get_objects()方法可以在(viewsets.ViewSet)类中重写吗？或get_objects()方法仅限于(viewsets.ModelViewSet) class?.Thanks
浏览 0提问于2018-04-12得票数 6
回答已采纳
我一直在尝试和寻找很多，但显然没有人有这个问题。所以问题是，我试图发送一个axios请求，用正确的api、ur和key删除。但DRF Model.ViewSet没有找到合适的PK功能。
后端--这是我的view.py文件：
class GigList(ViewSet):
def destroy(self, request, pk=None):
print(pk)
Gig.objects.filter(user=request.user, id=request.id).delete()
return Response
url
浏览 1提问于2022-01-10得票数 1
回答已采纳
我刚开始学习Django Rest框架，现在我学习了4个概念-- APIView、Viewset、Modelviewset、GenericView。它们之间有什么区别，在rest的开发中哪个更有效，为什么呢？
浏览 1提问于2021-05-10得票数 5
我正在与NSUserDefault确认这是否是第一次加载应用程序。这是我第一次必须将视图控制器推送到特定视图。我做了同样的动作，它起作用了，但第一次加载应用程序时却不起作用。
下面是我的代码：
SettingsViewController *viewSet = [[SettingsViewController alloc]
initWithNibName:@"SettingsViewController"
bundle:[NSBundl
浏览 2提问于2010-12-10得票数 0
回答已采纳
作为标题，我的CustomView扩展了ConstraintLayout，当在构造函数中使用ConstraintSet设置约束时，它不起作用。我试着约束postDelayed，它起作用了！
有没有约束条件的函数？
public class ConstraintAfterInit extends ConstraintLayout{
LinearLayout view;
public ConstraintAfterInit(@NonNull Context context) {
super(context);
浏览 10提问于2021-09-22得票数 1
我有一个Django Rest框架应用程序。身份验证通过登录方法执行：
def login(self, request):
user = find_my_user(request)
user.backend = 'django.contrib.auth.backends.ModelBackend'
login(request, user)
return Response({"status": "ok"})
身份验证工作正常。
我有一个具有list_route()的ViewSet，它需要使用经过身份验证的用户。代码如
浏览 2提问于2015-07-14得票数 2
我有两个模型有一个共同的领域(电子邮件)。我使用viewset.ModelViewset在两个模型中列出和创建数据。
我的models.py：
class Schema(models.Model):
"""Database model for Schema """
name= models.TextField()
version = models.TextField()
email = models.EmailField(unique = True )
def __str__(self):
浏览 5提问于2020-04-24得票数 0
回答已采纳
我曾经使用YAML Docstring指定参数，但现在它们已被弃用。我尝试过使用coreapi.Field，如下所示：
coreapi.Field(
name='id',
type='integer',
required=True,
location='query'
)
但它只适用于ViewSet.list，而不适用于ViewSet.create。根据的说法，这一直是一个持续的问题。评论中提供的解决方案对我来说是相当老套的。我希望有人已经找到(或想出)一个更简洁的解决方案或替代方案，可能是插件或其他什么。
浏览 16提问于2017-05-12得票数 2
我有一些具有filterset_fields和ordering_fields属性的ViewSet。此外，我在ViewSet中有额外的操作，它用作快捷方式来获取带有一些过滤的列表。我假设使用这个额外的操作，而不处理任何额外的过滤(或排序)选项。但在默认情况下，drf-yasg会使用filterset_fields和ordering_fields为该额外操作生成参数模式。
如何忽略特定端点的filterset_fields和ordering_fields属性？
浏览 22提问于2021-05-22得票数 1
我想定制的样式(字体，颜色，徽标等)的drf_yasg生成的文件。
我看到我可以用块extra_head、extra_styles、extra_body、extra_scripts来扩展drf_yasg/swagger-ui.html，如果需要的话，甚至可以覆盖其他块。
我不清楚的是我如何指向我的扩展swagger-ui.html的模板。
我从以下几点开始
class MyCustomSwaggerUIRenderer(SwaggerUIRenderer):
template = 'api/custom-swagger-ui.html'
我想在get_schema_vi
浏览 3提问于2020-06-08得票数 3
1回答
我的模型非常简单，但是我无法在ViewSet模板上创建一个“漂亮”的界面：
class Product(models.Model):
pid = models.PositiveIntegerField(unique = True)
price = models.DecimalField(Price, default = 0)
name = models.CharField("name", max_length = 128)
我创建了一个序列化程序：
class ProductSerializer(serializers.ModelSerializer):
浏览 0提问于2021-03-26得票数 0
3回答
因此，我一直在重构我的Sage300 API包装器 --我希望客户端代码感觉就像使用实体框架--这是我最接近它的地方：
使用(var context = new SageContext(/*redacted凭据*/)){ context.Open()；var header = context.PurchaseOrderHeaders.Single(po => po.Number == "NETAPI99")；header.Description，“更新测试”；var detail = header.Details.First()；detail.QuantityOrdere
浏览 0提问于2016-02-26得票数 10
回答已采纳
我在rest框架中使用viewset。我在不同的分页页中得到相同的对象。我怎么才能避免。
class Viewset(viewsets.ModelViewSet):
queryset = Model.objects.all().order_by('?')
serializer_class = MySerializer
pagination_class = StandardPagination
浏览 4提问于2022-08-10得票数 -1
1回答
我们如何在ModelViewSet中编写一个函数，在数据库中获得一个不同记录的列表？
假设我们有这个模型。
class Animal(models.Model):
this_id = models.CharField(max_length=25)
name = models.CharField(max_length=25)
species_type = models.CharField(max_length=25)
...
串行化
class AnimalSerializer(serializers.ModelSerializer):
class M
浏览 3提问于2016-11-11得票数 2
回答已采纳
我在Django中使用的是REST，我无法理解传统URL与实例化DefaultRouter()之间通过ViewSet注册URL的主要区别。
我有个模特：
class Article(models.Model):
title = models.CharField()
body = models.TextField()
author = models.ForeignKey()
像这样序列化模型：
from blog.models import Article
class ArticleSerializer(serializers.ModelSerializer):
浏览 7提问于2022-03-07得票数 0
回答已采纳
假设我们有一个ViewSet类：
class SomeViewSet(viewsets.ViewSet):
def create(self, request):
pass
def custom_action(self, request):
pass
我们注册SomeViewSet如下：
some_router = DefaultRouter()
some_router.register(r'some-route', SomeViewSet, basename='some-name')
因此，现在我们有了标准动作create的
浏览 2提问于2021-10-31得票数 0
Viewset def列表如下所示：
class ThreeDimensionalModelViewSet(viewsets.ViewSet):
serializer_class = ThreeDimensionalModelSerializer
queryset = ThreeDimensionalModel.objects.all()
permission_classes = [permissions.IsAuthenticatedOrReadOnly]
def list(self, request):
models = ThreeDime
浏览 0提问于2021-10-11得票数 0
回答已采纳
2回答
根据，以下两个代码段的行为应该是相同的。
class UserViewSet(viewsets.ViewSet):
"""
A simple ViewSet for listing or retrieving users.
"""
def list(self, request):
queryset = User.objects.all()
serializer = UserSerializer(queryset, many=True)
return Response(
浏览 1提问于2018-07-07得票数 2
回答已采纳
所以从本质上讲，我想向ViewSet发出一个请求，而不需要进行身份验证，那么Django APIRequestFactory实现了吗？这是可行的： from django.test import TestCase
from .views.SomeViewSet
from rest_framework.test import APIRequestFactory
class ViewSetsTest(TestCase):
...
...
...
def test_db_instance_viewset(self):
api_request =
浏览 21提问于2021-04-01得票数 0
回答已采纳
如何在ViewSet中按serializers.ListField订购
class FooSerializer(serializers.ModelSerializer):
bar = serializers.ListField()
例如：
我想按列表的第一个元素排序
GET http://localhost:8000/api/foo?ordering=bar[0]
{
...
results: [{bar:[1,'a']},{bar:[2,'c']},{bar:[3,'d']}]
...
}
浏览 17提问于2017-01-12得票数 2
回答已采纳
我的模特看起来
class Article(models.Model):
article_type = models.ForeignKey(
ArticleType,
on_delete=models.CASCADE,
related_name='articles'
)
title = models.CharField(
max_length=100,
verbose_name='Article Title'
)
count = model
浏览 3提问于2020-05-17得票数 3
回答已采纳
通过JSON发送3个视图时会出现以下错误
function BuscarOTPorId(){
if('<?=$this->uri->segment(3);?>'){
$.ajax({
type: "POST",
url: "<?= base_url()?>AgregarOTController/BuscarOTPorId/"+'<?=$this->uri->segment(3);?
浏览 2提问于2017-03-27得票数 0
1回答
我的脚本正在变量中存储一个ClearCase视图。要在此视图中操作，脚本需要在启动View后再次在View中调用自己。代码是这样的
if($params{ViewSet} eq 'no')
{
# Start the View
# Store the View in $View
# Call the Script in the new-set View with parameter -ViewSet yes
}
if($params{ViewSet} eq 'yes')
{
# Do
浏览 2提问于2015-11-26得票数 1
回答已采纳
当我试图访问生成的swagger文档时，我得到一个只有一个"Django登录“链接的空白页面。我正在使用drf_yasg库来呈现swagger文档。
生成swagger文档的代码类似于swagger文档中提到的代码。
schema_view = get_schema_view(
openapi.Info(
title="Snippets API",
default_version='v1',
description="Test description",
terms_of_ser
浏览 8提问于2020-05-27得票数 1
1回答
我正在使用一个ViewSet来实现restful API。
对于views.py中的类似操作，我希望使用这些API方法。
如何在views.py内部使用API调用？
下面是包含一个GET方法的ViewSet类：
class ProductViewSet(ViewSet):
@action(methods=['get'], detail=False)
def get_price_with_code(self, request):
some operations ...
下面是views.py，我想在index方法中使用get_price_with
浏览 6提问于2019-07-27得票数 0
1回答
我正在使用Django Rest框架，并且在权限方面遇到了一些问题。我知道如何使用has_permission和has_object_permission，但我有很多情况需要有人能够访问retrieve而不是list--例如，用户可以访问自己的配置文件，但不能访问完整的配置文件列表。问题是，has_permission总是在has_object_permission之前被调用，所以has_object_permission只能是更多的限制，而不是更少。
到目前为止，我能够做到这一点的唯一方法是拥有更多的许可权限，然后直接在ViewSet中覆盖ViewSet，并在逻辑中包含权限检查，但是我实际上
浏览 0提问于2014-07-10得票数 1
我想通过在Django REST框架中实现的rest框架来记录在django Model对象上执行的所有CRUD操作。我扩展了viewsets.ModelViewSet以创建用于定义REST API端点的自定义viewSet类。
浏览 0提问于2014-10-17得票数 7
我正在用Django rest框架编写REST，我想用权限保护某些端点。权限类似乎提供了一种优雅的方法来完成这一任务。我的问题是，我希望对不同的重写ViewSet方法使用不同的权限类。
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
def create(self, request, *args, **kwargs):
return super(UserViewSet, self).crea
浏览 7提问于2016-03-13得票数 32
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
