问题标签 [drf-yasg]

我正在使用drf-yasg文档，我正在使用redoc并且效果很好。但我想添加x-serverand x-taggroups。我想为视图设置自定义标签，并将它们添加到他们自己的标签组中，但是我在文档中找不到任何关于这个的东西，我应该怎么做？

我正在为我的 Django Rest API 文档使用 drf-yasg 包。默认情况下，它只显示一个名为“Payload”的请求示例，如下面的链接所示。 https://i.stack.imgur.com/1Pno2.jpg 我想添加更多请求样本，如下图所示。 https://i.stack.imgur.com/yy9tv.png

我在使用时定义了一些接口drf-swagger，它们需要指定接受参数才能正确返回内容。例如，我将返回一个文件以供下载。显然，application/JSON参数不能提供正确的格式。 我希望能够向响应内容类型添加新选项。可能已经有解决方案了，但是没找到~

我使用drf-yasg库为开发人员前端生成项目文档。我不知道如何将我的数据添加到字段参数和响应

比如这个类

但我并没有完全得到我想要的

如何添加这些参数？

如何禁用 drf_yasg 中的授权按钮？（我仍然希望 CSRF 工作）

更新：目前，我有这种设置，因为我想删除 Django 登录并维护 csrf。但是，授权按钮仍然存在（如何删除授权按钮并维护 csrf）

我使用Django、DRF、drf-yasg和Swagger Codegen来自动构建 TypeScript 代码来访问我的 REST API。

在 Django 后端中，我添加了一条与 DRF 一起提供的路径：

DocumentViewSet是一个 DRF ModelViewSet。

如您所见，source_id参数是数字类型。但是，生成的 API 描述将source_id参数定义为 String 类型。

显然路径设置中的数字正则表达式是不够的，所以我想我需要在DocumentViewSet类中添加一些类型注释？我尝试了以下代码，但这没有效果：

如何告诉 drf-yasg 将source_id参数设置为整​​数类型？

目前我在 drf 上使用 LimitOffsetPagination，并使用 drf-yasg 记录 API。

我写了一个这样的视图：

现在我想用swagger_auto_schema.

我想知道有没有办法在这些操作视图上自动生成/添加分页响应模式和参数。

如果我使用SubModel1Serializer(many=True)on swagger_auto_schema(responses={...})，响应模式将仅显示为 SubModel1s（或 2s）的数组，没有 prev、next、items 等字段。

谢谢你。

我试图强制dry-yasg正确解析路径中的参数。假设我们有

在 swagger 文档中，它不被视为int，string而是

我用过

但这很烦人。我找不到负责解析它的函数/方法/类。是否有一种简单的方法可以根据路径更改此解析器的行为，以便如果int发生openapi.TYPE_INTEGER则将返回而不是返回string？

我有几个用作枚举的模型（基本上，模型只是一个名称和一个蛞蝓），如货币和国家等，我试图在 drf-yasg 中显示可用的选择但没有成功。我最后一次尝试是将它添加到序列化程序的 Meta 类中：

但是当然它失败了——它不仅没有显示枚举值，而且还破坏了序列化程序（因为它使用字符串而不是实际模型）。

有没有办法做到这一点？

我的views.py中有以下内容

我一直在阅读文档并试图找出是否有办法排除此视图的某些端点。

我可以将视图全部排除在外

schema=None

我试着用

这会改变“get”端点的描述。

但尝试

抛出错误

AssertionError:方法or方法can only be specified on @action or @api_view views

这是一个错误吗？或者只是不支持的功能，有没有办法完成我正在尝试的事情？

非常感谢。