问题标签 [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 投票
0 回答
102 浏览

python - 如何在我的 Django+drf-yasg 项目中使用 editor.swagger.io 中的 swagger.json?

我在我的项目中集成了 drf-yasg,生成 json 文件:python manage.py generate_swagger swagger.json. 之后,我在 editor.swagger.io 中编辑我的swagger.json并将其导出。现在,我如何在我的项目中使用这个手动创建的 swagger.json 文件而不是自动生成?谢谢。

0 投票
1 回答
174 浏览

django - 如何使用 {format} drf-yasg 排除请求?

每个人。我正在使用 drf-yasing 在 drf 上为我的 api 编写文档。我的每个请求都有一个带有 {format} 的副本。我怎样才能删除它?我的问题

例如我的简单视图:

网址:

ps对不起我的英语:)

0 投票
1 回答
245 浏览

django - 必须安装 `coreapi` 以获得架构支持

我正在尝试使用 生成 swagger 文档drf_yasg,它工作正常,但现在不行。它给了我错误,我找不到解决方案。

知道为什么我会收到此错误吗?

0 投票
0 回答
24 浏览

django-rest-framework - drf_yasg 如何在 redoc 中对请求进行分组

我所有的 api 都在 fid 下,因为我的 URL 是 fid/{fid_id}/investors 或 fid/{fid_id}/users

我如何分成不同的群体说投资者和用户

现在它只显示fid

0 投票
0 回答
54 浏览

django-rest-framework - 如何为 drf 的未指定键创建序列化程序(用于 drf-yasg)

我想序列化/反序列化没有固定键的对象。

我知道为此目的有 DictField 。

但是,由于这是一个字段,而不是序列化程序,我需要一个序列化程序,将 dictfield 包装为根对象的键。

这意味着,使用 DictField,我可以接受以下对象,

但仍然无法处理的对象,

当然,简单地使用json.loads(request.data)效果很好,但我没有生成正确的模式。

然而,我想要的是,

  1. 使用序列化器
  2. 将其分配为 serializer_class
  3. 使用 drf-yasg 自动创建 swagger 文档

一种可能的解决方法是,手动将 swagger_auto_schema 装饰器的 request_body 参数设置为手动 openapi 格式规范。但这对我来说是最不利的选择。

总之,我想对未指定的键使用序列化程序,以便为 drf-yasg 正确生成模式。为了实现这一点,我应该几乎完全重写 drf 的序列化程序类吗?或者有一个简单的方法?

0 投票
0 回答
40 浏览

api - 如何使用 drf-yasg 在 django-rest-framework 中为文件上传 API [Post Method] 制作招摇模式?

即使在定义 @parser_classes([FileUploadParser]) 之后,我也无法在 Swagger-UI 中获取文件上传按钮。请帮忙..!

0 投票
0 回答
106 浏览

python-3.x - drf-yasg - 从 urls.py 中读取 http_method_names

我有一个Settings子类,APIView它有 2 种方法。

urls.py中,我有以下内容,

如您所见,我想在方法id中作为参数传递get,而不是在post方法中传递。

drf-yasg,理想情况下应该只在 Swagger 页面上显示 2 个方法,但它显示了 4 个方法。

我已经尝试添加@action(methods=['GET']), @api_view['GET']。但它不起作用。

我如何告诉drf-yasghttp_method_namesin读取允许的方法urls.py

我可以将其保留id为可选,并且在 中只有一个条目urls.py,但在文档页面上大摇大摆地将其标记为必需。

也试过了,还是不行

0 投票
1 回答
499 浏览

django - 如何使用 drf-yasg Swagger 手动自定义 DRF 视图的参数?

我正在使用drf-yasg包将 Swagger 与 DRF 集成。

正如文档所说,我使用@swagger_auto_schema装饰器手动自定义自动生成的端点。经过多次尝试,我仍然无法弄清楚为什么没有任何变化。

因此,我尝试将额外的查询参数添加到RetrieveUpdateAPIView

毕竟,似乎什么都没有改变。那我到底要做什么?

0 投票
0 回答
63 浏览

django - Django - 我的 asgi websocket 路径如何在我的大摇大摆中

我正在创建一个 api,其中两个端点使用 ws(s) 协议。
由于我的 API 位于 Google 端点之后,因此每个端点都需要定义到 OpenApi2.0 文件中。

为了创建这个定义,我使用了 drf-yasg。

我有一个路由。py 文件如下:

我将它注册到我的 asgi.py 文件中,如下所示:

不要介意导入顺序,这是由于此错误:使用 asgi 时尚未加载 Django 应用程序

所以我的套接字按预期工作,现在,我想要我的命令行:python3 manage.py generate_swagger swagger.yaml将这些新端点添加到我的 swagger 文件中。

我试图直接将我的 url 添加到同一个对象,然后我的所有其他 url 像这样:

但是我的招摇文件中没有任何显示。

有任何想法吗 ?

谢谢

0 投票
0 回答
396 浏览

python - drf-yasg 涵盖对以下实施的标准 api 响应的所有响应

我确实在我的应用程序中实现了标准 API 响应,例如这篇文章。我还为我的 API 文档实现了 drf-yasg。正如我们所知,模式正在使用直接序列化程序来呈现响应。我如何使用 drf-yasg 模式涵盖以下所有这些响应示例?

1. 成功单身

2. 成功名单

3. 错误或失败


目前我只是从 drf_yasg 实现了一般模式,但仍然不知道该怎么做。