问题标签 [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 回答
140 浏览

django-rest-framework - 我正在尝试将我的 djangorest api contactsapp 部署到 heroku

我是 python 和 djangorestframework 的新手。当我运行 python manage.py 检查时,我得到 ModuleNotFoundError No module named 'drf-yasg'。事实上,我已经使用 pip install drf-yasg 安装了这个模块。我还使用 pipenv install drf-yasg 将它安装在 pipfile 和 Pipfile.lock 文件中我还在 settings.py 文件中添加了模块,但错误仍然存​​在。我 这里是错误的截图

0 投票
1 回答
330 浏览

django - swagger 中 POST 和 PUT 方法的有效负载

我正在使用 yasg 库为我的 api 制作一个文档。但我有一个问题:GET 和 DELETE 方法很好,但是当我想使用 POST 或 PUT 方法时,我无法为它们定义有效负载。在参数部分它说:没有参数这是我的代码:

我能做些什么?

0 投票
1 回答
1205 浏览

django - filterset_fields 的 drf-spectacular 问题

我正在尝试实现drf-spectacular现有的 Django REST API。

但是,尝试运行时出现以下错误

错误:

过滤器确实有效,但似乎不能很好地与 drf-spectacular lib 配合使用。谁能建议如何解决这个问题?

规格如下:

视图集示例:

序列化器示例:

0 投票
1 回答
385 浏览

django-rest-framework - 将文档添加到 generics.RetrieveAPIView 'retrieve' 方法的查询参数

我有一个简单的视图,它将“电子邮件”作为查询参数,我希望将它记录在 OpenAPI 自动生成的模式中。到目前为止,我尝试在 API View 类定义上method_decorator一起应用swagger_auto_schema,但没有成功:

自动生成的模型仅包含来自序列化程序的主体信息。有什么想法有什么问题吗?

DRF:3.12.2

drf-yasg:1.20.0

我的招摇模式添加到 urls.py 中:

0 投票
2 回答
1452 浏览

django - 如何使用 drf_yasg 对 swagger API 端点(基于函数的视图)进行分组 - Django

我正在从 Django 1.11 --> 3.1.5 做一些迁移工作

以前使用“rest_framework_swagger”,我可以在 url.py 中完成 swagger api 分组

并得到这个(注意它分组 v9)

在此处输入图像描述

但是,我在 Django 3.1.5 url.py 上尝试过使用“drf_yasg”

我的 api 定义(请注意我使用的是@api_view)

但是,我明白了(注意到 v2 没有分组)。而且当我进行测试时,也有错误。(代码 404 错误:未找到)

在此处输入图像描述

如何将这些分组到 drf_yasg 中的 API 并确保没有错误?注意如果 url.py 是这样的,没有错误但它不分组

0 投票
0 回答
125 浏览

python - 在 django 中实现 drf_yasg (swagger) 的问题 (AssertionError ModelSerializer)

几天来,我试图在 Django==3.1.3 中实现 drf_yasg。我总是按照这里写的说明-> https://drf-yasg.readthedocs.io/(安装,网址)。但是,一旦我访问本地机器上的 url 中定义的 swagger url,总是会发生错误->: 截图

控制台打印:

为什么会这样?如何解决?

0 投票
1 回答
1179 浏览

django - drf-yasg:在 Swagger 文档中显示 ListAPIView 的自定义分页

我在 Django REST 框架中有以下 ListAPIView 和自定义分页类:

视图.py

自定义分页类

目前,我正在尝试弄清楚如何在 drf-yasg 生成的 Swagger API 文档中显示自定义分页类。

我已经从 drf_yasg.inspectors 定制了 PaginatorInspector,但不知道我需要把它放在哪里才能将它用于上述 ListAPIView。

自定义 PaginatorInspector

由于我正在使用其他 ListAPIViews 并在 settings.py 中指定了默认分页类,因此自定义分页类应仅用于 ListAPIView“价格趋势”。

0 投票
0 回答
131 浏览

django-rest-framework - 如何将 drf-yasg 集成到 Django Rest 项目中?

我正在尝试将其集成drf-yasg到我的 Django Rest 项目中。我通过 pip 安装了库并将这些代码行添加到url.py如下。

我的观点之一是;

我的 /redoc 页面已创建。但是,它没有内容。它只有 APIView 名称,如下所示。

在此处输入图像描述

我如何填写文件?

0 投票
2 回答
665 浏览

django - 如何从 drf-spectacular API 文档中删除 RetrieveUpdateAPIView 中的 put 方法?

我有以下看法:

视图中一切正常,但问题是我正在使用 drf-spectacular,它在文档中向我展示了一个 PUT 方法,我们在 API 中不需要。我的问题是,如何自定义 drf-spectacular 在文档中不包含 PUT 方法?

在此处输入图像描述

0 投票
1 回答
720 浏览

django - 如何隐藏自动生成的模式中的字段,或明确定义模式?

我正在使用drf-yasgDjango REST Framework - Yet Another Swagger Generator)为我的 RESTful API 生成文档,但它并没有完全符合我的要求。我认为设置read_onlywrite_only属性 toTrue会隐藏文档中的字段,因为它们在请求和响应主体中被省略,但事实并非如此。我没有看到任何在装饰器中定义模式的例子,甚至只是隐藏一个字段,但如果我能学会如何做其中的一件事情,我会处于良好状态。

让我们来看一个基本的例子:用户登录。

这些序列化器分别生成TokensLogin建模,分别以以下.json.yaml格式定义:

但是,这些并不适合每个请求或响应正文,我想明确定义模式,或者使用省略字段的现有模式。我不知道如何实现后者,但这是我对前者的尝试,这会导致错误:

我能想到的唯一其他选择是为每个模式创建一个序列化程序,但这似乎比必要的更费力。有什么想法吗?