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

django - 带有招摇设置内容类型的 django DJA

我想为我们的 API 使用 JSON API 格式,而 django-rest-framework-json-api似乎非常适合。

但是,我也使用招摇。现在 DJA 遵循内容协商客户端

加载 swagger 文档很顺利,但是当我想尝试某些东西时,它不遵循 JSON API 内容协商。当我更改 curl 命令并在 shell 中运行它时,一切正常。

如何更改 Django 招摇以添加 Content-Type: 'application/vdn.api+json' ?

(这基本上是第一个问题django-rest-framework-json-api/issues,但是,她没有说明她是如何解决这个问题的,只是第二个问题)

0 投票
0 回答
511 浏览

python - Django Rest Swagger 中未显示嵌套 URL

我正在尝试使用 Django Rest Swagger 记录我的 Django REST API。

我的主要 url conf 如下所示:

tickerapi/urls

如您所见,我的网址是嵌套的,以便让不同的视图处理以下网址:

  • /tickers/{channel_name}(操作:PUT、PATCH)
  • /tickers/{channel_name}/ONAIR(操作:GET)
  • /tickers/{channel_name}/{carousel_name}(操作:GET、PUT、PATCH)

我的问题是 Django Rest Swagger 只显示嵌套 url 的一部分,如下所示: Django Rest Swagger Screenshot

据我所知,Django Rest Swagger 正在考虑/tickers/{channel_name}/tickers/{channel_name}/{carousel_name}是同一个端点。实际上,如果我只允许对视图处理/tickers/{channel_name}/{carousel_name}进行 GET 操作(使用 ListAPIView),那么缺少的嵌套 URL 将显示在 Swagger 中,减去 GET 操作:Django Rest Swagger Screenshot

有没有人遇到过这个问题?我正在使用 Django 1.10.5、 Django Rest Framework 3.5.4和 Django Rest Swagger 2.1.1

谢谢你的帮助

0 投票
2 回答
5102 浏览

django - Django rest swagger post 参数未显示在 Swagger 文档上

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

我的解析器设置,

}

这是我的视图类片段,`

网址映射:

]

我的招摇文档生成, 在此处输入图像描述

无法将 json 有效负载作为输入传递给发布请求。

0 投票
1 回答
151 浏览

python - Django REST Swagger:Swagger 未检测到 List 和 Retrieve 函数

我正在使用 django-rest-swagger 版本:2.0.5 和 django-rest-framework 版本:3.4.6。

我意识到当我使用listretrieve运行时,Swagger 无法将它们检测为新端点。

我的 views.py 文件中有以下代码:

我期待在 openapi.json 文件中看到以下端点:

  • 订单/
  • 订单/{uuid}/

但它们没有被呈现。我应该添加一些特定于这些功能的东西以便被 Swagger 检测到吗?

0 投票
1 回答
730 浏览

python - Django REST Swagger:如何添加 oauth2/token 端点

我正在使用 django-rest-swagger 2.1.1 版。我使用 oauth2_provider.urls 来构建 oauth2/token 端点,如下所示:

问题是 Swagger 没有将其检测为端点,因此它在我的 openapi.json 文件中丢失了。

为了能够被 Swagger 检测到,我可以对这个端点做些什么?

0 投票
3 回答
4680 浏览

python - Django Rest Framework:如何为基于函数的视图启用 swagger 文档

我浏览了Django REST Swagger 2.1.2 文档。当我尝试使用基于类的视图时,它工作正常。

但我没有找到任何关于如何为基于函数的视图启用招摇的参考,如下所示:

我的大部分内容views.py都充满了基于功能的视图,就像上面一样。

任何有关如何启用相同功能的帮助将不胜感激。谢谢!

我正在使用Django:1.8;Django REST Swagger:2.1.2;DRF:3.6.2

0 投票
2 回答
2011 浏览

python - django_rest_framwork 发生“类型错误:‘链接’对象不支持项目分配”

一个使用 Django、DRF、swagger 的项目。

网址配置如下:

和存储/urls.py:

和views.StoreViewSet:

之后python manage.py runserver,访问http://127.0.0.1:8000/#并发生 TypeError:

错误消息显示,Link对象不能像 dict 一样赋值。

如果我将方法名称从detail_exportto重命名details_export,一切都会再次正常。

rest_framework 的@list_route装饰器将方法的 url 传递给 Link 对象时发生猜测错误。

为什么其他方法就好了?我该如何解决这个问题?

0 投票
0 回答
123 浏览

python - DJango Rest Swagger 2 的核心 API 中的 `paramType: form` 等价物是什么?

在旧的 django rest swagger 中,可以paramType: form在 viewset 的 docstring 中指定,并通过 获取参数request.data['param_x'],如下:

在较新的版本中,我通常使用coreapi.Field指定参数的属性,并将参数类型设置为location参数键(例如core.api.Field(name='param_x', location='query'))。文档中讨论了所有可用的位置值。然而,他们似乎都没有按照我的预期去做(甚至没有location='form')。

如何form使用较新版本的 django rest swagger 设置参数类型?我可能在这里遗漏了一些东西。

0 投票
1 回答
2564 浏览

python - 如何在 Django REST Swagger 2 中记录参数?

我曾经使用 YAML Docstring 指定参数,但现在它们已被弃用。我试过使用coreapi.Field,如下:

但它只适用于ViewSet.list,而不适用于,比如说,ViewSet.create。根据这份报告,这是一个持续存在的问题。评论中提供的解决方案对我来说非常骇人听闻。我希望有人已经找到(或想出)一个更简洁的解决方案或替代方案,也许是插件或其他东西。

0 投票
2 回答
1690 浏览

python - Django REST 框架 + Django REST Swagger

很难配置 Swagger UI 以下是非常解释性的文档 - https://django-rest-swagger.readthedocs.io/en/latest/。我的 settings.py 看起来像这样。

在此处输入图像描述

urls.py 看起来像这样。

在此处输入图像描述

但是招摇的网页没有正确加载。

在此处输入图像描述

控制台日志如下。

在此处输入图像描述

这里可能有什么问题?