问题标签 [django-rest-swagger]

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 投票
1 回答
210 浏览

django-rest-framework - 如何在使用 GenericView 和 django-rest-swagger 时显示 POST/PUT 请求的单个参数的输入框

我正在使用Django REST Framework(3.9.4)和django-rest-swagger(2.2)

view.py我使用generic class-based views诸如generics.ListCreateAPIViewgenerics.RetrieveUpdateDestroyAPIView

在 swagger 页面中,它正确地使用了所有 API 及其相应的方法调用。

当它是一个 API 调用时PUT,因为{id}它要求在输入框中提供输入。但是对于 request-body 它要求提供整个 Json 作为输入。

我想将其更改为对于所有请求正文参数,它们中的每一个都将作为一个单独的输入框出现,类似于标头的 id 字段(我们在可浏览的 API 显示中看到的那种)

我怎样才能做到这一点?

在此处输入图像描述

0 投票
1 回答
1381 浏览

django - django-rest-swagger UI 没有 POST 请求正文的表单(基于函数的视图)

我用 django-rest-swagger 装饰了这个基于函数的视图。但是,我在 UI 中找不到允许我发布有效负载(request.body)的位置。

我看到了一些关于使用基于类的视图的解决方案,但我想知道是否有办法使用基于函数的视图来做到这一点。

先感谢您!

在此处输入图像描述

0 投票
9 回答
11359 浏览

python - django_rest_swagger - 'staticfiles' 不是注册的标签库。必须是以下之一:

尝试在 django 2.2.4 中为 django rest 框架自动生成 API 文档时出现此错误,从我在日志中看到的内容来看,这与 {% load staticfiles %} 的弃用有关

我的 urls 文件,它的格式与 django_rest_swagger 文档中的格式相同:

0 投票
0 回答
49 浏览

python - responseMessages 未在 Django-Swagger 集成中显示

我正在使用 DRF YASG 来记录我的 API。

我想从这里删除对 PUT 和 PATCH 的调用。对于这里的视图,我使用了viewsets.ModelViewSet。

可用的 API 调用

另一个应用程序对其views.py 使用API​​view。如何排除特定 url 的方法。

我的视图包含两种方法 POST 和 DELETE。但是为了实现这些方法,我有单独的 URL。

问题是两个 URL 都显示了这两种方法,而且列表变得太大了。

在此处输入图像描述

问题可能类似,但我有一个限制,即不更改以前的代码库。

0 投票
2 回答
2495 浏览

python - 为 get 和 post 请求定义不同的模式 - AutoSchema Django Rest Framework

我正在尝试在 Django REST 框架中为我的 REST API 定义 AutoSchema(显示在 django REST 框架中)。有这个类扩展了 APIView。

该类同时具有“get”和“post”方法。喜欢:

问题是我想要获取和发布请求的不同架构。如何使用 AutoSchema 实现这一目标?

0 投票
2 回答
585 浏览

django-rest-framework - Django rest swagger 文档显示选择文件作为字符串

我正在使用 django rest 框架 django rest swagger 创建简单的 swagger 文档。

这是模型.py

我创建了serializers.py

这里还有image_view.py

图片上传显示为字符串。

在此处输入图像描述

如何解决这个问题?

0 投票
1 回答
51 浏览

django - 从父类到子类函数的文档字符串

我有一个Django==2.2.3带有djangorestframework==3.9.4and的应用程序django-rest-swagger==2.2.0。我想为我的 api 端点提供单一的事实来源(用于数据验证和 api-docs)。我有一个看起来像这样的 JSON

我从中创建了一个 json 模式,并且验证正在工作。

此 json 转换为 yaml 字符串,供django-rest-swagger. 它是如何使用 yaml 的,您需要将 yaml 放在 doc 字符串中。但我不想为每件事都写同样的东西。会有很多端点,并且为所有这些端点编写相同的东西感觉不对。

所以我想如果我创建一个基类并将 json 发送到该基类,它可以为我创建所有 doc 字符串,使用 json 并将其动态地放入所需的函数中。我现在面对一个拦截器,它说。

AttributeError:“方法”对象的属性“__ doc __”不可写

这就是我的班级的样子

TLDR:

获得的错误:AttributeError:方法对象的属性 __ doc __ 不可写

问题:如何从父类更改子类函数的文档字符串?

0 投票
2 回答
2214 浏览

python - 如何在招摇领域添加示例

我目前正在使用以下 django 库 -

它在 Python 3.7.4 版本上运行

我面临的问题是我可以在 Autoschema 中使用 corapi.Field 生成 API 的主体部分。

现在,我可以生成如下所示的 Swagger 视图 -

在此处输入图像描述

但我想通过 coreapi.Field 在这个 body 部分中添加一个示例数据,如下所示 -

我该如何添加?我现在无法更改任何版本的 Django 或 Python。

0 投票
1 回答
1131 浏览

django - Swagger Django [规范中未定义操作]

我一直在尝试将 Swagger 与 Django Application 集成并遇到此错误:规范中未定义操作!

我的项目结构是

我将 drf_yasg 用于我的目的。我已经在 settings.py 和 App2 中包含了所有详细信息,我在 urls.py 中有这个:

我的类视图(例如(class Att(generic.TemplateView)和方法在App下的views.py中声明。我尝试了@swagger_auto_schema,@api_view等方法来在文档中显示应用程序类和函数。但它只返回No规范中定义的操作!。

我也尝试使用路由器来注册视图,但没有成功,甚至 django-rest-swagger 也失败了。任何帮助表示赞赏。谢谢!

0 投票
2 回答
6097 浏览

django - Django - ImportError:无法为 API 设置导入“drf_yasg.generators.OpenAPISchemaGenerator”

我正在尝试将https://github.com/axnsan12/drf-yasg这个库添加到我们的 django 应用程序并得到以下错误。

经过一些研究,我发现有些人建议安装这个包来解决这个问题

但这没有任何区别。还有其他可用于 django rest api 的好的 api 文档库吗?