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

python - Django REST Swagger 不显示 POST 方法

我在使用 Django REST Swagger 时遇到问题。我为使用 DRF 的用户创建了一个简单的视图集(只是为了显示我的问题),其中 AppUser 是我的自定义用户模型,它没有在我的文档中显示 POST 方法,但我可以用 Postman 调用它并创建一个新资源.

我在用着:

  • 姜戈 2.1
  • Django-rest-swagger 2.2.0
  • Djangorest框架 3.9.1

这是我的代码:

视图.py

序列化程序.py

网址.py

在这里您可以看到我的应用程序文档的样子:

实际的 API 文档

我想得到这样的东西:

理想的文档

我已经尝试了多个有关创建 Swagger 文档的教程,并且正在用户模型上进行尝试,但我仍然只收到 GET 请求。我究竟做错了什么?

谢谢您的帮助。

0 投票
1 回答
206 浏览

django-rest-framework - 像 https://petstore.swagger.io/#/pet 这样的招摇导航在我的项目中不起作用

我见过的所有 Swagger 应用程序都可以在与端点相关的块之间导航,如下所示:https ://petstore.swagger.io/#/store/getInventory

当您单击某些块时,URL 会发生变化。无法理解我做错了什么,但我没有这样的事情。我的浏览器一直显示相同的 URL,即就像没有 #的“ https://petstore.swagger.io/ ”等。

我如何使用 Swagger 的一些示例。为了确保它不是关于我的项目,尝试了一个教程,但它有同样的问题

序列化程序.py:

视图.py:

网址.py:

我做错了什么?谢谢!!

0 投票
2 回答
913 浏览

django-rest-framework - Django JWT 身份验证不会加载所有受保护的 url

当我在swagger中使用我的api登录并在弹出的授权按钮中填写信息时,我的受保护的api列表仍然没有出现。

我尝试将其添加为“不记名令牌”,但它不起作用。

以下是我的代码:

我正在使用 django-rest-swagger==2.2.0。它适用于招摇 2.1.2

0 投票
1 回答
268 浏览

django - Django Swagger Schema:布尔类型的对象不是 JSON 可序列化的

我正在处理自定义架构,Object of type Boolean is not JSON serializable但在 Swagger 文档页面上出现错误提示。

我注意到 usinglocation="query"不会产生上述错误,但我在formfor Swagger 中需要它。有什么解决方法吗?提前致谢!

0 投票
1 回答
651 浏览

django - Django DRF Swagger:在 urls.py SimpleRouter / DefaultRouter 中,swagger 文档不会自动发现

Django DRF Swagger 文档未显示注册为 ROUTERS(不是 urlpattern)的 ModelViewSets API 端点。在下面的示例中,标准文档 (rest_framework.documentation) 显示/记录了这个“follow_up”API,而 swagger 文档没有,完全跳过没有显示。对于 urlpatterns 来说,一切都很好,下面的“this_is_showing”代码被很好地记录了:

来自 urls.py 文件

我错过了什么?

django-rest-swagger==2.2.0,djangorestframework==3.11.0

编辑 1

django-rest-swagger 包不再维护!

移至 drf_yasg:内部带有 swagger 和 reDocs 的出色工具。

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

django - 用于 json 字段的 drf swagger ui

无法在 post body 参数的 swagger-ui 中显示 json 数组字段。我有带有 JsonField 列的 django 模型,列名显示在 swagger ui 中,但无法显示在 json 值中。请您提出您的建议。

对于使用上述模型和序列化程序,我有以下请求正文,

但预期的输出是,

在此处输入图像描述

0 投票
1 回答
64 浏览

python - 自定义操作方法中的搜索字段

现在我正在学习 DRF,并且必须用相册做项目。我的任务之一是使用模型字段“标题”创建自定义@action“补丁”方法,但我不明白如何在自定义方法中添加搜索字段。我们可以在基本方法中看到它们,例如“get”、“patch”和“put”,但我找不到任何有关如何将它们添加到自定义操作的信息。如果有人知道该怎么做,请告诉我。

我的模型:

我的观点:

我的观点:

0 投票
2 回答
38 浏览

python - 如何在 Swagger 中包含 Oauth2 身份验证网址?

我将 Django drf-spectacular OAuth Toolkit 用于 Oauth2 密码流。不幸的是,Swagger 无法识别身份验证 URL。这是我的 urls.py

我该如何解决?