未显示drf_yasg文档参数
是指在使用drf_yasg库生成API文档时，某些参数没有显示在文档中的情况。drf_yasg是一个用于Django REST framework的扩展，可以自动生成符合OpenAPI（以前称为Swagger）规范的API文档。
在生成API文档时，drf_yasg会根据视图函数或视图集的装饰器、请求方法、参数类型等信息自动生成文档内容。但有时候，由于一些原因，某些参数可能无法正确显示在文档中。
解决未显示drf_yasg文档参数的问题，可以尝试以下几个步骤：
- 检查视图函数或视图集的装饰器：确保使用了正确的装饰器，如
@swagger_auto_schema。这个装饰器可以用于自定义API文档的展示方式，包括参数的显示。 - 检查参数的定义方式：确保参数的定义方式正确。drf_yasg支持多种参数类型，如路径参数、查询参数、请求体参数等。根据具体情况选择正确的参数类型，并使用
@swagger_auto_schema装饰器进行参数的详细定义。 - 检查参数的位置：drf_yasg会根据参数的位置自动将其显示在文档的不同部分。例如，路径参数会显示在路径中，查询参数会显示在请求参数列表中。确保参数的位置正确，并使用
@swagger_auto_schema装饰器进行位置的定义。 - 检查参数的可选性：有些参数可能是可选的，而有些参数可能是必需的。确保参数的可选性设置正确，并使用
@swagger_auto_schema装饰器进行可选性的定义。 - 检查文档生成配置：drf_yasg提供了一些配置选项，可以用于自定义文档的生成方式。检查文档生成配置，确保没有禁用或隐藏某些参数的显示。
如果以上步骤都没有解决问题，可能需要进一步检查drf_yasg的版本、与其他库的兼容性等因素。可以查阅drf_yasg的官方文档（https://drf-yasg.readthedocs.io/）获取更多信息和帮助。
腾讯云相关产品和产品介绍链接地址：
- 腾讯云API网关：https://cloud.tencent.com/product/apigateway
- 腾讯云云函数（Serverless）：https://cloud.tencent.com/product/scf
- 腾讯云容器服务：https://cloud.tencent.com/product/ccs
- 腾讯云数据库（云数据库MySQL版、云数据库MongoDB版等）：https://cloud.tencent.com/product/cdb
- 腾讯云CDN加速：https://cloud.tencent.com/product/cdn
- 腾讯云人工智能（腾讯云智能图像处理、腾讯云智能语音合成等）：https://cloud.tencent.com/product/ai
- 腾讯云物联网（腾讯云物联网开发平台、腾讯云物联网通信等）：https://cloud.tencent.com/product/iot
- 腾讯云移动开发（腾讯云移动推送、腾讯云移动直播等）：https://cloud.tencent.com/product/mobile
- 腾讯云对象存储（腾讯云COS）：https://cloud.tencent.com/product/cos
- 腾讯云区块链服务（腾讯云区块链服务平台）：https://cloud.tencent.com/product/bcs
- 腾讯云游戏多媒体处理（腾讯云游戏多媒体处理平台）：https://cloud.tencent.com/product/gmp
- 腾讯云元宇宙（腾讯云元宇宙开发平台）：https://cloud.tencent.com/product/mu
相关·内容
2回答
我正在使用drf_yasg自我记录我的应用程序接口，它是使用django-framework构建的，但是任何端点都没有显示任何参数。我的方法是在http请求主体中以JSON格式传递参数。然后，我从request.data读取参数。下面是其中一个视图的示例，其中它将'id‘作为请求正文中的参数。ResponseSerializer(GeneralResponse(False,"Not registered as a donor")).data, status=
浏览 74提问于2020-10-05得票数 1
是否有一种方法可以像在operation_id中显示drf_yasg那样在drf_spectacular中显示drf_yasg？文档没有显示有关此设置的任何内容。
浏览 8提问于2022-11-01得票数 0
回答已采纳
我试图记录我的Django rest框架API，我正在跟踪文档。我首先看到了一些错误: Pycharm说“类‘type’的未解决属性引用'with_ui‘” on schema_viw.with_ui(.)。下面是密码。import staticfrom drf_yasg.views import get_schema_view
准确的错误。我怎么才能解决这个错误。'django.con
浏览 0提问于2021-07-10得票数 1
Django DRF Swagger文档没有显示注册为路由器的ModelViewSets API端点(不是DRF模式)。在下面的示例中，标准文档(rest_framework.documentation)显示/记录了这个"follow_up“API，而swagger文档没有显示，总跳过什么都没有显示。移到drf_yasg:一个很好的工具，里面有swagger和reDocs。
浏览 2提问于2020-07-05得票数 2
我使用redoc + drf_yasg来生成使用django-rest-framwork生成的api的文档。只要我添加一个入口点，它就能很好地工作，它在文档中显示得很好。但是，我不知道如何在文档中添加在查询过程中可以提供的搜索参数。例如，在list函数中，我可以传递两个可选参数，id和name： """
A simple ViewSe
浏览 27提问于2021-06-09得票数 2
1回答
我正在使用drf_yasg创建我的swagger文档，但是我对PaginationInspector有一个问题。在我的一个视图中，我声明了一个分页器，在swagger中，显示为swagger的默认分页。我尝试使用装饰器，最初我认为它可能类似于@swagger_auto_schema(paginator_inspectors=False)，但它不起作用，我在文档中找不到任何有用的东西。
浏览 11提问于2022-04-06得票数 0
1回答
我正在使用drf_yasg实现我的目的。urls.py中包含了以下内容：from drf_yasg.views import get_schema_view
from drf_yasg我尝试了@swagger_auto_schema、@api_view等方法来显示文档中的应用程序类和函数。但它只返回没有在规范中定义的操作！。
浏览 4提问于2020-08-07得票数 4
是否可以为应用程序中的每个设置标头参数。我可以在全局配置或每个视图方法中设置它吗?如果是，我如何做到这一点？
浏览 14提问于2022-03-16得票数 2
回答已采纳
method='post', manual_parameters=[x_param,y_param])def test(request):我把drf_yasg{}
将post参数添加到swagger中是错误的吗
浏览 12提问于2018-06-19得票数 25
我正在使用django-yasg创建一个api文档。但是文档中没有显示任何参数来创建post请求。下面是我的代码:在swagger中，没有为post请求显示创建事件的参数。
浏览 3提问于2022-06-18得票数 1
', in_=openapi.IN_QUERY, ]) 上面的代码显示了GET参数，但以某种方式隐藏了响应模式。@swagger_auto_schema(methods=['put', 'post'], request_body=UserSerializer) 我不能将request_body用于GET查询参数，
浏览 27提问于2019-09-21得票数 8
回答已采纳
(即，未压缩)shutil.make_archive(base_name, format[, root_dir[, base_dir[, verbose
浏览 0提问于2013-04-02得票数 1
回答已采纳
例如，如果我这样做：我看到所有的承诺：* 2fe1c92 branch4| * d33bf64 master4* a286c74 master3* 6f58634 master1* e8599bb (HEAD -> branch) branch5
| * f083
浏览 6提问于2017-09-21得票数 3
因此，我的问题是，我如何能够直接跳到一个特定的网站和一个特定的文档在该网站上，例如，第3页和那里的第5文档。是否可以执行多个锚链接(打开站点，跳转到重复控件中的页面，而不是文档.)。
浏览 3提问于2013-07-10得票数 1
默认情况下所有的Inno安装页面(没有自定义屏幕)是什么，它们看起来如何，它们的顺序是什么，它们的默认设置是什么，以及如何更改这些设置？
浏览 2提问于2016-09-01得票数 5
回答已采纳
1回答
对于未保存的文档，Word将在第一个Word进程中打开AutoRecovery窗格。如果启动第二个Word进程，将不再显示恢复窗口。false;但是任何其他的Wordprocess都不提供“文档恢复我将得到一个“参数超出了有效值范围”的异常。
有没有办法在每个show进程上显示文档恢复窗口？
浏览 6提问于2022-01-04得票数 0
1回答
有没有一种方法可以使用python将web acl与aws api gateway关联起来？我尝试使用CLI命令测试我的代码但它不起作用，我甚至尝试从aws控制台将web acl与api网关关联，但web acl列表未在下拉列表中列
浏览 0提问于2019-12-18得票数 1
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
