问题标签 [drf-yasg]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
91 浏览

django-rest-framework - 有没有办法覆盖生成的 drf api 模式的默认描述?

在使用 drf-yasg 或 drf-spectacular 时,<br /> 有没有办法覆盖示例图片中显示的默认描述,
或者 drf-yasg 或 drf-spectacular 是否为默认描述提供其他语言支持?

我尝试了对 drf-spectacular 的 i18n 支持,但我认为这不是为了这个问题。
并且更改 django 的 language_code 设置是行不通的。

我非常感谢您的帮助。
样品 1 样品2

0 投票
1 回答
57 浏览

django - 我可以根据是否从 swagger 调用视图返回不同的 Django 响应吗?

我正在为我的 API 使用Django-Rest-Framework。我正在使用drf_yasg记录该 API 。我的一个观点返回一个 Django FileResponse

当我直接在“http://localhost:8000/api/my_documents/1”访问视图时,它成功显示(PDF)文件。但是当我通过 swagger 访问它时,它成功返回 200 但给出以下消息:

无法识别的响应类型;将内容显示为文本。

这是大摇大摆本身的问题的b / c 。正如该票证中所建议的,如果我将“Content-Disposition”响应标头从“inline”更改为“attachment”,问题就会消失。但是,我不想总是下载文件。

我的问题是:我可以确定请求是否是由视图中的 swagger 发出的并有条件地更改标头吗?就像是:

谢谢。

0 投票
0 回答
366 浏览

django - 如何在 drf yasg (swagger) 中更改日期字段的示例格式值

您好,我正在使用 drf yasg 库在我的基于 django 的应用程序中实现 swagger。我已将 settings.py 文件中的日期格式更改为如下所示:

现在,当我尝试大摇大摆地测试我的端点时,我得到了格式错误的日期字段示例:

当我尝试执行请求时,我收到错误:

预期会收到什么,但每次我想使用它时都更改示例日期很烦人。任何提示如何在招摇示例中实现相同的格式?

0 投票
1 回答
540 浏览

django - drf-yasg:如何更改 operationId?

在此处输入图像描述

使用 drf-yasg 时如何更改 redoc-ui 中自动出现的请求的名称。

例如:在图像中,您可以看到请求名为 fid_data-entities_update,它是从 URL 中提取的。

如何覆盖/重命名它?

0 投票
1 回答
238 浏览

django-rest-framework-simplejwt - drf_yasg rest_framework_simplejwt JWTAuthentication 不起作用

设置.py

视图.py

则未提供 API 返回身份验证凭据。因为令牌是错误的

0 投票
1 回答
346 浏览

django - 内部和外部 API 的单独文档 (drf_yasg)

我有两组 API:内部,用于我们在团队中开发的客户端应用程序,以及外部,由我们的业务合作伙伴使用。我想要一个文档页面,通过身份验证,向我们的开发人员显示内部 API,向所有其他查看者显示外部 API。我怎样才能做到这一点?

我使用:Django、DRF 和 drf-yasg。

PS:我知道这个问题很笼统,但我不知道从哪里开始。我只猜测 get_schema_view 中的一些设置、我的视图和 URL 模式是必需的。

0 投票
2 回答
501 浏览

django - drf-yasg:图像字段未在 swagger ui 中显示

我是 django-rest-framework 的新手。我正在使用 DRF 和 drf-yasg Swagger。任何机构都可以帮助从请求主体上传图片吗?我无法从请求正文上传图片。我当前的view.py:

my_serializer.py:

任何人都可以解释这个问题吗?

0 投票
2 回答
275 浏览

django - 如何在 drf-yasg 中排除特定端点的显示过滤器

我有一些 ViewSetfilterset_fieldsordering_fields属性。此外,我在该 ViewSet 中有额外的操作,它用作通过一些过滤获取列表的快捷方式。我假设使用该额外操作而不处理任何额外的过滤器(或可能是订购)选项。但默认情况下,drf-yasg 使用filterset_fields和为该额外操作生成参数模式ordering_fields

我如何忽略特定端点的属性filterset_fieldsordering_fields

0 投票
0 回答
104 浏览

django - Django admin url 可以在使用 drf-yasg 的 swagger 文件上吗?

我正在 Google Endpoint 上部署 Django API。
Google 端点需要使用 openapi2.0 生成的文档来设置所有端点。如果在由 openapi(这里是 drf-yasg)生成的 yaml 文件中没有定义 url,即使端点可用,也无法到达端点。

事情是,在我的 api 上访问我的 django 管理区域对我来说非常非常有用,但是当我生成我的 yaml 文件时,它会跳过我的管理 url。

这是我的网址,基本:

你知道怎么做吗?

谢谢

0 投票
1 回答
617 浏览

django - 嵌套序列化程序的 Yasg 模式生成显示不正确的请求/响应

我有一个 Django API,我尝试使用 drf-yasg 创建文档。我的嵌套序列化程序和 ListAPIview 的自动生成架构有问题。它看起来像这样:

序列化程序.py

视图.py

和 urls.py:

端点工作正常,但 swagger 没有创建正确的请求或响应,当我访问它时,它给了我这个错误消息:

我不能包含序列化器类名,因为我使用多个序列化器,我不能为此创建单个序列化器,因为它们被拆分为不同的模型。覆盖 get_serializer_class() 不起作用,因为我也不知道如何将这些序列化器合并到那里。我怎样才能使这种表示工作?提前致谢