问题标签 [django-rest-swagger]

使用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-rest-swagger==2.1.1与使用djangorestframework==3.5.3.

该项目有一些基于类的视图和一些基于函数的视图。集成 swagger 后，它显示“基于类的视图”（显然有序列化器）的 POST 请求的输入框，但不显示“基于函数的视图”。这个问题被问了好几次，我尝试了以下解决方案：

解决 方案1 ​​解决方案2

其他人也很少，但对我的情况不起作用。对于“基于函数的视图”是否有任何可能的方法，或者我必须将它们转换为基于类的视图？

我正在尝试集成django-rest-swagger==2.1.1到具有基于功能的视图的现有项目中。

为了将缺少的参数添加到基于函数的视图中，我使用了这个解决方案：

daemon 的解决方案

我在 yaml 中指定了所需的参数，它也在 swagger UI 中显示了该字段。现在在我看来request.POST['key']给None. 但request.body包含必需的参数。我应该如何修改招摇设置，以便视图能够使用request.POST['key'].

我已经尝试过解决方案，但它对我不起作用。

我创建了一个AssetsFilter类：

现在我在我的 Viewset 中使用这个过滤器，如下所示：

创建 swagger 文档时，过滤器字段按预期出现在GET (list),中，GET (retrieve)但它们也出现在POST,和它们不应该出现的位置。PUTPATCHDELETE

如何禁用这些参数出现在最新版本的 django-rest-swagger 和 DRF 中？

在方法文档中使用django rest framework和django-rest-swagger它没有显示可用的 GET 参数，问题是我该如何设置？

代码：

http 接口：

现在： 示例：

俄语版。

我将 Django Rest Framework 与 Django Rest Swagger 一起用于 API 文档。似乎“试用”按钮总是提交http请求，而不是https请求，即使浏览器是https。

如果我重建整个 CoreAPI 规范，我知道如何做到这一点，但只想将 protocol = 'https' 之类的东西传递给 django_rest_swagger 或其他不需要重新编码 API 文档框架的东西。

我正在将 Django Rest Swagger 与 Python 2.7 和 Django 1.11 一起使用。我正在尝试将 OAuth 身份验证与 Swagger 一起使用。我已将其包含在我的 settings.py 中

}

当我单击 Swagger 中的 Authorize 按钮时，它不会询问客户端 ID，而是显示以下屏幕。

如何使用 OAuth 身份验证制作 Django Rest Swagger wotk？

I. 我是使用 Django REST Swagger 编写 API 文档的新手。我试图了解如何编辑 a）“实施说明”和 b）参数描述。下图——

这是我对“崩溃”模型的看法。

我对 DocString 进行了一些编辑，但不太了解如何进行以便更全面地描述端点及其字段。我尝试阅读Django REST Swagger 教程，但没有给出关于如何格式化 DOCSTRING 的任何指示。最好的方法是什么？

二、另一个小问题是我想去掉“Django Login”按钮，因为这是公共 API。我该怎么做呢？

三、API 文档有哪些最佳实践？

我正在使用 DRF 中的 get_schema_fields 方法来实现模式字段。在表单字段的招摇 UI 上，而不是我给它的[" metrics "] 的名称将数据显示为名称。模型示例也没有出现。

这是代码

如何将该字段名称从数据重命名为指标以及如何显示模型样本？

I am trying to install django-rest-swagger into a virtual machine but it is giving error Failed Building wheel for simplejson i tried searching for some solution but as far as i was able to understand is that there is some dependency on visual studio... i have microsoft visual studio 2015 installed on my system I am attaching the installation report and see just before the error its written unable to find specified path and there is a path for library of visual studio