问题标签 [django-swagger]

I'm looking for how to make a GET in django swagger framework by refClient (a unique CharField in my client's model). I found on the internet that I have to customize the routers, I have that as routers :

But I got this error

Should I add something to my serializers's configuration

Or to my views ?

Basically how I can customize my swagger ?

我正在为我的项目设置 Django-rest-swagger。我对 Django-restframework 有以下设置。

现在，当我拥有像这样的权限类的视图时

我看到以下视图

但是当permission_classes像这样添加两个视图时

我看到这样的观点

我不想在每个视图中添加权限类，因为我的所有视图都有相同的类，并且我在我的休息框架设置中提到了这一点。我怎样才能做到这一点？

我用 django rest 框架和 django rest swagger 编写 Web API。

• django-rest (0.0.1)
• django-rest-swagger (2.1.2)
• djangorestframework (3.6.3)

我尝试在视图方法或 APIView 方法中编写 Swagger YAML。方法功能没问题，功能描述渲染没问题。但是 GET/POST 方法参数不能被渲染。

视图方法不是使用任何数据库模型，而是自定义模型。

• 如何在参数部分呈现自定义模型字段。
• 如何在 Swagger UI 参数部分呈现 POST 正文。
• 参数部分无法渲染，如何显示。

PS如果我用coreapi.Document写一个页面，参数可以很好地呈现。但是这种方式对于 API 文档来说太复杂了。希望 YAML 在 APIView 方法或 ViewSet 方法上没问题。

使用django-rest-framework-json-api我能够创建 API 端点，其工作方式如文档中所述。尝试提供 API 文档使用django-rest-swagger并不容易。

media_type = 'application/json'1：在 JSON API 中不支持的Swagger 使用。为了解决这个问题，我创建了第二个渲染类 ( renderer_classes)，它对 JSON API 进行子类化JSONRenderer并强制使用媒体类型。

现在端点支持application/json并且application/vnd.api+jsonswagger 很乐意在 JSON API 文档结构中呈现。请注意，生成的 curl 请求没有标准的 JSON API 标头。

2：Swagger 与解析器有同样的问题。虽然第 1 期的工作确实有效，但还有一个次要挑战。Swagger 呈现一个字段名称的平面字典，它不是 JSON API，最终由 DRF 请求。

是否有可能在 JSON API 中大摇大摆地解析？目前 Swagger 不适用于 PUT 或 POST。

我正在使用 Django 1.11 和 Django REST Framework 3.7 开发一个 REST API。我安装了Django REST Swagger 2.1 来生成文档。

我正在使用这样的基于函数的视图：

如您所见，我的视图已被 Swagger 识别，并且具有正确的描述：“在此处查看描述”。

然而：

• 您可以看到URL 参数的“描述”列是空的。provider
• POST 参数没有记录（显然，因为 Swagger 无法知道它们）

如何为基于函数的视图的 URL 和 POST 参数以及响应编写文档？

我尝试了YAML Docstrings，但它似乎适用于旧版本（0.3.x）并且不适用于 2.x 版本。

我正在使用OAuthToolkit和 DjangoRestSwagger。我已经使用 Django Admin 创建了一个应用程序，现在我已经client_id和client_secret.

我想使用client_idand生成令牌client_secret。目前，我curl用来生成令牌。

我怎样才能使用 Swagger 文档来做到这一点？基本上，如何将第三方（OAuthToolkit）API URL 与 Swagger 集成？

目前，我有一个Authorize具有价值的按钮api_key，即令牌。

这是我的 Swagger 设置。

我的 django-swagger 可以正常使用我的 API。但是，当我尝试将 Djoser url 包含到我的 urlpatterns 中时，我得到以下回溯：

这是我的 urls.py：

如果我包含 djoser.urls.jwt 或 djoser.urls.autotoken - 没有问题。如果我包含 djoser.urls.base – 就会出现问题。

在这个问题上找不到很多。

我正在使用 django 2.0.1、DRF 3.8.2、django-rest-swagger 2.1.2 和 djoser 1.1.5。

有人遇到过这个问题吗？

我在编写视图集和使用django rest docs时尝试记录 API 。我有以下问题：

• 如果我尝试发送反向相关字段的值，它需要值列表，但是在 Form-data 中发送数据时，它以字符串的形式出现。

• 文档 UI 中没有文件上传选项。

以下是我的代码：

模型.py

视图.py

序列化程序.py

我正在使用 http://www.django-rest-framework.org/topics/documenting-your-api/

默认文档中的图像字段中没有文件上传。

谢谢

我想将 Swagger 添加到 Django 休息框架，但我无法获取 POST 正文参数...

我所做的：

serrings.py

网址.py

视图.py

但我的招摇总是看起来像：

在这种情况下，我无法发布我的身体参数（json）来尝试一下......如何解决这个问题

过去一年左右我一直在使用 django 进行编码，我的大部分工作是编写 API 以连接到基于 React 的前端。在我的大多数教程中，我看到人们使用 GenericAPIViews 作为基础知识，但我没有发现 API 中复杂代码的任何实质性内容。所以为了及时交付我的代码，我选择了更简单的解决方案，即使用 APIView，我使用更少的抽象，对我的代码有更多的控制（通过编写更多的代码）并清楚地了解我的代码模块的功能。

我担心的是，如果我选择了不学习如何使用 GenericAPIViews 的捷径，这样我就可以充分发挥它的潜力。我在使用 GenericAPIViews 或 DRF 时遇到的一些问题。

• 自定义权限（例如，我想要一个经过身份验证并且具有特定权限级别的访问权限的用户（例如 can_do_xyz 或 has_access_to_abc）
• 使用可能需要通过复杂的业务/应用程序逻辑层的可写序列化程序
• 在同一个 GenericAPIView 类函数中为多个模型创建条目。

目前，我在使用基本 APIView 的方法中遇到的问题是，我设法编写的招摇文档是垃圾。

• 我需要在 api 模式文档中手动指定查询/表单/路径字段（使用 AutoSchema）
• 此外，如果 API 具有具有不同字段的 get/post/put/delete 方法，则 swagger 中的每个 API 端点都将显示跨方法使用的所有字段（这是可以理解的，因为我为类而不是为单独的功能）。有没有办法解决这个问题？
• delete 方法应该只需要survey_id 作为参数，而POST/PUT 方法需要body。