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

python - Django REST Swagger 给出 400 错误

我正在尝试在(https://docs.djangoproject.com/en/2.0/intro/tutorial01/)上运行 Django REST Swagger,以确保我了解它的工作原理,然后再尝试将 Django REST Swagger 集成到我的更大项目中.

我所做的:我从示例 Django 项目中获取代码并尝试集成 Django REST Swagger。

setting.py我添加rest_framework_swaggerINSTALLED_APPS。我的静态文件内容如下:

urls.py中,我有:

当我在 localhost 上运行项目时(使用python manage.py runserver),结果如所附屏幕截图所示。相关部分是左侧屏幕上的 localhost 和最右侧的终端。

在此处输入图像描述

任何帮助将不胜感激。如果您需要更多信息,请发表评论。我觉得有一个简单的解决方法,因为我错过了将 Django REST Swagger 集成到项目中的一步,但经过数小时的谷歌搜索后,我目前无法弄清楚。

0 投票
2 回答
3725 浏览

python - django-rest-swagger 的请求和响应模式,用于在 DRF 中记录 API

我想在 DRF 中使用 swagger 生成器工具django-rest-swagger记录我的 API

现在我正在通过继承来编写视图rest_framework.views.APIView

我不想使用视图集或序列化程序编写视图。

这是查看代码示例

现在我可以为每个端点添加描述。 swagger ui中每个api端点的描述

我想添加请求和响应模式,如下所示swagger 中每个端点的模型模式

我想知道,如何在不使用序列化程序和视图集的情况下实现这一点。

0 投票
1 回答
566 浏览

django - 如何覆盖 get_swagger_view 以使 django-rest-swagger 显示所有端点?

默认情况下django-rest-swagger显示不需要身份验证的视图(在这种情况下为 JWT Auth)。我试图get_swagger_view通过添加权限类来覆盖默认快捷方式,IsAuthenticated以包括也需要身份验证的视图。但是这次我一访问渲染的文档,我就明白了No operations defined in spec!

如何显示需要和不需要身份验证的视图。

0 投票
2 回答
1696 浏览

django - Django REST Swagger 使用 permission_classes=[IsAuthenticated] 隐藏 ModelViewSet

我在我的 Django 项目中使用了Django REST Swagger 。它能够显示所有带有没有的视图的 URL permission_classes = [IsAuthenticated]。虽然 permission_classes = [IsAuthenticated]list-api 中未显示带有的视图。

这是一个例子:

如果我删除 permission_classes = [IsAuthenticated],它会显示在 swagger list-api 中。我将 swagger 降级为 2.1.2 并单击授权并传递令牌。

奇怪的是我的值中有一个前缀“令牌”。当我登录时 Token<tokenvalue> 登录失败。但是当我通过它时,它得到了身份验证,但 没有显示带有isAuthenticated<tokenvalue>的视图。

请建议应该做些什么来显示添加了isAuthenticated的视图。

0 投票
1 回答
450 浏览

django - 在 django-rest-swagger 中将枚举渲染为下拉列表

我正在尝试获取django-rest-swagger生成的 swagger 文档中显示的正确查询参数

但这并没有显示为下拉菜单。

我们如何将选择呈现为下拉菜单?

0 投票
1 回答
600 浏览

django - 如何在 Django rest swagger 中传递 post 参数?

我已将 swagger 与 django rest 框架集成,但 swagger 文档不会创建输入框来发布数据以进行发布请求。

我正在使用带有装饰器的基于函数的视图(@api_view)

在 urls.py 我添加了:

在 settings.py 中:

}

但是,当我打开 api url 时,我得到了这样的东西(在图像中),我无法通过 post 传递参数api命中url截图

这里可能是什么问题?还有其他需要做的改变吗?

0 投票
0 回答
370 浏览

django - 身份验证类不可见的 django-rest-swagger 2.2.0 端点

我正在开发一个 django 应用程序,它有一堆定义了自定义和基本身份验证类的端点,但是 swagger 只显示没有身份验证类并且具有权限类 = AllowAny 的端点。

如何在没有任何身份验证/权限的情况下使所有端点在“docs/”端点上可见?

Django==2.1.7 djangorestframework==3.9.1 jango-rest-swagger==2.2.0

REST_FRAMEWORK = { 'DEFAULT_PERMISSION_CLASSES': ( 'rest_framework.permissions.AllowAny', ), 'DEFAULT_AUTHENTICATION_CLASSES': ( 'rest_framework.authentication.SessionAuthentication', ), 'DEFAULT_PARSER_CLASSES': ( 'rest_framework.parsers.JSONParser', 'rest_framework.parsers.FormParser', 'rest_framework.parsers.MultiPartParser', ) }

SWAGGER_SETTINGS = { 'exclude_namespaces': [], # List URL namespaces to ignore 'api_version': '', # Specify your API's version. Might be useful in future 'api_path': '/', # Specify the path to your API not a root level 'enabled_methods': [ # Specify which methods to enable in Swagger UI 'get', 'post', 'put', 'patch', 'delete' ], 'token_type': 'Bearer', 'api_key': {}, # An API key 'is_authenticated': False, # Set to True to enforce user authentication, 'is_superuser': False, # Set to True to enforce admin only access }

0 投票
1 回答
313 浏览

python - 如何设置端点以使用 Django REST Swagger 发布

我有一个带有Django Rest Framework的大型 API REST 项目,我想用Django REST Swagger记录它,但我希望这个Swagger文档只包含我整个项目的一些端点。

这是我urls.py在项目中设置Swagger的地方:

目前,Swaggerurls.py发布了整个项目中的所有端点。我想将其设置为ursl.py仅在项目的应用程序中发布端点。

0 投票
0 回答
370 浏览

django - 我们如何在 django rest swagger UI 中使用 APIVIEW 为我们的 django-rest api 指定 header 参数和 post 参数

这是我的应用程序/views.py

应用程序/serilaizers.py

当前 Swagger UI 的屏幕截图,因为没有标题参数和 post 参数的字段。

版本:

django-rest-swagger==2.1.0

djangorestframework==3.9.1

0 投票
1 回答
412 浏览

django-rest-framework - Json schema django rest框架,将json字段描述为json而不是字符串

我在 DRF 中有一个 Api,大摇大摆地描述。在我的序列化程序中,我有一个这样的字段:

是否有可能在 swagger.json 中将该字段描述为“Json”而不是字符串: