28得票1回答
Django Rest Framework - 如何将POST参数添加到API文档(drf_yasg)?

x_param = openapi.Parameter('x', in_=openapi.IN_FORM, description='srring', type=openapi.TYPE_STRING) y_param =...

14得票5回答
drf-spectacular使用错误的AutoSchema生成Swagger。

之前我在使用drf-yasg,但想要更新为使用OpenAPI 3。我试图切换到drf-spectacular。按照说明,我运行了pip install drf-spectacular,删除了所有对drf-yasg包的引用,并将Settings.py更新如下:INSTALLED_APPS = [...

13得票2回答
验证Swagger API文档(drf-yasg)

我已经设置了DRF-YASG,但是不知道如何配置它来显示需要身份验证的视图。 以下是配置: schema_view = get_schema_view( openapi.Info( title="Swagger Doc", default_v...

13得票2回答
如何在ViewSet的文档字符串中清晰地记录可能的REST操作?

DRF 文档 提到: 请注意,使用视图集时,基本文档字符串用于所有生成的视图。要为每个视图提供描述(例如列表和检索视图),请使用文档字符串部分,如Schemas as documentation: Examples中所述。 但是链接失效了,类似的链接https://www.django...

12得票1回答
使用Django和drf-yasg时重复使用序列化器的问题

我正在使用django、django drf和drf-yasg来编写我的后端并生成文档。 我有一个名为User的模型和一个用于用户的序列化器: class UserSerializer(serializers.ModelSerializer): class Meta: ...

11得票4回答
我应该如何在drf-yasg生成的自动化Swagger页面中配置“HTTPS”方案?

我知道在传统的Swagger YAML文件中,我们可以使用以下方式定义模式: schemes: - http - https //OR schemes: [http, https] 然而,我该如何使用drf-yasg库自动生成的Swagger页面完成同样的操作呢? 现在,生...

11得票2回答
如何在drf_yasg中将方案从HTTP更改为HTTPS?

我正在使用 drf_yasg 来进行Swagger文档的编写。当我将我的DRF应用程序发布到AWS应用程序负载均衡器后,并设置侦听器在443 HTTPS上进行侦听并重定向到运行DRF的EC2实例时,Swagger UI尝试发送请求到端点http://example.com/status而不是例...

10得票2回答
Django, drf-yasg - 如何在标签中添加描述?

Swagger文档说您可以这样做: https://swagger.io/docs/specification/grouping-operations-with-tags/ 但不幸的是,drf-yasg没有实现此功能: https://github.com/axnsan12/drf-ya...

10得票1回答
DRF - `write_only=True`在响应模式中显示。

我正在使用drf-yasg来记录我的API。但是,我遇到了一个问题。我有一个序列化器,在其中一个字段中设置了write_only=True。class XYZSerializer(serializers.ModelSerializer): status = serializers.Bo...

9得票1回答
DRF YASG自定义

我正在尝试定制使用yasg构建的API文档。 首先,我想确定自己部分的命名方式,以及应该在此部分包括哪些终端点。似乎部分名称基于不属于最长公共前缀的第一个前缀,例如: 如果我们拥有网址api/v1/message和api/v1/test,则部分名称将被命名为消息和测试。是否有办法为此部分确...