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

python - 在 drf_yasg 中记录基于类的视图时出现“http 方法未绑定到视图”

以前,我记录了我的基于函数的视图,如下所示:

然后我们将视图切换到基于类的视图,所以我简单地将文档装饰器复制粘贴到post方法中:

然而,在运行这个装饰器时,drf_yasg抛出了异常

到底是怎么回事?这个错误信息是什么意思?

0 投票
1 回答
9217 浏览

django - 验证 Swagger API 文档 (drf-yasg)

我已经设置了DRF-YASG,但无法弄清楚如何配置它以显示需要身份验证的视图。

下面是配置。

这些public_apis是我希望人们在进行身份验证后看到的 API。

使用上述配置,它不会显示单个 API。它只显示AuthorizeButton 和文字No operations defined in spec!。但如果我更改public=Falsepublic=Truethen 它会显示所有 API。

PS:之前我使用的是Django Rest Swagger,并且我能够将其配置为仅在提供 JWT 令牌后才显示 API。

我正在使用 JWT 进行身份验证。

权限变更例外:

另一个问题是,如果我将上面的权限更改为 DRF Permission 类,渲染将失败并出现以下错误:

我尝试将其更改为permmissions.IsAuthenticated我自己的自定义权限类,但它们都失败并出现相同的错误。

0 投票
1 回答
323 浏览

django-rest-framework - Wagtail 和 Django Rest 框架 drf-yasg?

我正在一个更大的(主要是 DRF)驱动的应用程序中实现一个 Wagtail 驱动的博客。我正在尝试将 drf-yasg 用于我的文档。

自从安装 wagtail,文档现在正在抛出

'Request' object has no attribute 'wagtailapi_router'

它看起来与 drf-yasg 所做的内省有关,我能找到的关于从 drf-yasg 中排除视图的所有信息都是在代码级别完成的。作为一个已安装的模块,我显然想避免这种情况。

有没有人让这 2 (3) 个组件一起玩得很好?

0 投票
2 回答
5647 浏览

python - 将模型字段序列化为嵌套对象/字典

想象以下模型:

我有一个ModelSerializer暴露所有字段的 django rest 框架。但我希望能够将地址字段序列化为字典。因此,当序列化为 json 输出时:

我尝试创建一个AddressSerializer

然后设置PersonSerializer.address使用AddressSerializer

这导致我的架构是正确的。我使用drf-yasg. 它查看序列化程序以生成正确的模型定义。所以序列化器需要表示模式。

这就是我目前所处的位置。显然现在它失败了,因为模型中没有address属性Person。你将如何解决这个问题?

0 投票
1 回答
12292 浏览

django - django rest 框架 - 如何将 post 参数添加到 api 文档(drf_yasg)?

我用作drf_yasg招摇。

我完成了上面的编码并用 swagger 对其进行了测试,当我用 Chrome 进行检查时,请求有效负载是x = 124 & y = 124124.

并且,通过以下消息,发生了错误的请求错误。

大摇大摆加post参数有错吗?

0 投票
1 回答
873 浏览

python - DRF - `write_only=True` 显示在响应模式中

我正在使用drf-yasg来记录我的 API。但是,我遇到了问题

我有一个序列化程序,其中一个字段设置为write_only=True.

生成 swagger 文档时,字段status仍显示在响应字段中。从技术上讲,它不应该。

如何纠正这个?

0 投票
1 回答
1565 浏览

django - 没有斜杠的 DRF 发布网址

在我的应用程序中,我需要在末尾不带斜杠显示 REST url。我尝试过以下组合,但没有奏效。

APPEND_SLASH=True在 settings.py 中添加

在 urls.py 文件中

当我在邮递员的末尾调用不带斜线的 url 时添加此内容后,它给了我一个 404 错误-找不到 URL。但是最后使用斜线可以正常工作。

是否有任何选项可以使此网址末尾不带斜线?特别是对于帖子网址

0 投票
1 回答
1317 浏览

python - 在评论中添加招摇的描述

我可以通过评论视图集自定义招摇描述吗?我使用drf-yasg

我的代码:

我的序列化器

我想在这里添加描述: 在此处输入图像描述

我该怎么做?

0 投票
3 回答
1463 浏览

django - 排除特定 HTTP 方法的 swagger 文档

我使用drf-yasg为我的 Django REST API 生成 swagger 文档。我有几个端点,items/带有 GET、POST 和 DELETE 方法;和items/<uuid:itemID>仅使用 DELETE 方法。但是,生成的 swagger 文档错误地还包括后一个端点的 GET 和 POST。

这是我在 urls.py 中的一个片段:

views.py 包含如下内容:

如何从items/<uuid:itemID>文档中排除 GET 和 POST?

我已阅读https://github.com/axnsan12/drf-yasg/blob/master/docs/custom_spec.rst从 Django REST Swagger 中排除 URL,但尚未找到可行的解决方案。

0 投票
2 回答
869 浏览

django - 如何从 DRF 中删除自动生成的字段 - Swagger UI

我有一个模型,其中很少有自动生成的字段。如何在 POST 请求期间从 Swagger UI 中隐藏这些字段?以下是示例:-

下面是我的序列化器:-

在上述模型中,字段bd是从我的代码自动生成的,这意味着这些字段不需要作为用户的输入。

如果我添加bd作为只读字段,那么我将无法创建具有这些值的对象。

如何从有效负载请求中隐藏一些属性。?有点类似这个