问题标签 [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.
django - 有没有办法使用 Django Rest Swagger 记录 POST 请求中所需对象的组成?
假设我有一个Player
需要创建Team
对象的端点:
模型.py
我有一个 ModelViewSet 如下:
视图.py
序列化程序.py
当我查看我的 Django Rest Swagger 时,POST
创建播放器所需的数据的“示例值”如下所示:
我想要的是{}
被扩展,以表明我需要提供一个{"name": "string"}
对象来创建Team
对象。我试过添加
team = TeamSerializer(help_text="{'name': 'string'}")
PlayerSerializer
只是将数据添加到 Django Rest Swagger 上的选项Model
卡。有没有办法将此文档自动添加到Example
选项卡并Model
显示所需的POST
数据?
django - 如何使用 django_rest_swagger 2.1.1 显示 API 描述
对于 0.3 版本,DRF 能够读取 Swagger 设置中的信息数据并在 Swagger UI 中呈现。
但是对于 2.1.1 版本,似乎不支持 info 字段swagger_settings
?标题可以按如下方式传递:
但似乎没有办法将描述传递给get_swagger_view
,因此我无法在 Swagger UI 上显示描述。这个版本有解决方法吗?谢谢。
python - 如何将 swagger-ui 与 Django Rest Framework 和 Django-Rest-framwork-Swagger 集成?
我正在编写一个通过 DRF 公开 API 的 Django 应用程序。通常,我会从代码生成模式并通过 swagger-ui 和 Django 的 django rest framework swagger 插件公开 API 文档。该插件使用 2 个渲染来执行此操作,例如:
schema_view = get_schema_view(
title='app api title',
renderer_classes=[OpenAPIRenderer, SwaggerUIRenderer]
)
这次我的用例有点不同。我想要做的是渲染一个已经存在的 swagger.yml (我不想从代码中动态生成它)。我猜想需要将现有的 swagger.yml 注入 SwaggerUIRenderer,但我没有这样做......
有什么办法可以通过其余的招摇插件来做到这一点?
django - 在 Django REST 框架中记录正文参数
我有一个简单的 APIView 从某些子系统获取日志文件:
它subsystem
以 query_param 形式获取参数,但需要从 JSON 获取更多额外数据以执行额外过滤。
这个视图在模型中没有表示,它执行一些文件系统操作并返回文件,所以我没有序列化程序可基于。
我想像上面的代码片段一样记录这个方法,并用 Swagger 制作 Django Rest Framework 来理解它,并让我通过带有附加参数的 swagger 执行查询。
使用获取参数它可以正常工作,但是如何添加这些request.data
参数来工作?
python - 如何配置 django restframework swagger 基本路径
我需要在开发服务器上为我的 Django restframework apis 设置 swagger UI。我使用 Django rest swagger 并将其添加到使用 apache2 部署项目的设置中已安装的应用程序中,并且 url 是user41.dc/django/
所以我的 API usr41.dc/django/api/
..
但 Swagger UI 发送请求以usr41.dc/api/
跳过'/django'
和swagger相关的设置
注意:它可以正常使用localhost:port/api
python - 如何在 Django REST 框架中创建部分搜索过滤器?
我正在使用 Django REST 框架库,我正在尝试制作一个可以按 first_name、last_name 或两者过滤的过滤器。这是我的ContactViewSet.py:
我的 DRF settings.py
:
我当前的请求 URL 如下所示:
但我正在寻找这样的东西:
django-rest-framework - 将基本 URL 添加到 Django Rest Swagger
我找不到将 BASE URL 添加到django
rest swagger
. 我尝试添加
到settings.py
. 但它不起作用。
python - Django REST Swagger HTTPS 请求
如何配置django-rest-swagger以获取 HTTPS 请求?
upd:存在 SSL 证书并且所有应用程序都在使用它,但大摇大摆地发出 http 请求。
python - 如何在 django-rest-swagger 包中仅显示一些 URL 文档
我正在使用Django-rest-swagger
Package 来记录我的 API,但我只想显示一些 URL 来记录我的项目中有几个应用程序 - 一些答案是 USE Exclude 但最新版本它不起作用 - 我正在使用djangorestframework==3.5.1
andDjango-rest-swagger==2.1.0
和Django-rest-framework
API。
我什至尝试了渲染模式和get_swagger_view(title='API Documentation', patterns=urlpatterns1)
.
但它不起作用。
帮助我找到解决方案。