【问题标题】:Django swagger special character escape documentationDjango swagger 特殊字符转义文档
【发布时间】:2018-05-16 07:04:02
【问题描述】:

我使用 django 和 swagger。我像这样在我的 django 函数中编写文档字符串:

/?first_name__icontains=saeed&age__gte=20. 

但是大摇大摆地向他们展示这样的

如何在 django 和 swagger 中转义 & 等字符?

编辑:

我在 django 视图的文档字符串中的代码

招摇的结果

【问题讨论】:

  • 您的代码中究竟在哪里使用了这个字符串?请发布您的代码。您还可以发布更大的 Swagger UI 屏幕截图,在上下文中显示该字符串吗?该模式的详细说明越容易有人帮助您。
  • 我更新了问题,感谢您的通知。
  • 对不起,但仍然没有足够的细节......根据我的理解,看起来你有一个带有 Markdown 标记的 description 并且该行应该被格式化为代码(使用 4 个空格indent) 但 Swagger UI 不正确地呈现该行。这是你的问题吗?
  • 我在我的文档字符串中键入 &,但大摇大摆地显示 &。我认为&是swagger中的一个特殊字符,但我不知道如何逃避它。

标签: django escaping swagger docstring


【解决方案1】:

& 在代码块中呈现为 & 是 Swagger UI 2.x 中的一个错误,该错误已在 UI 3.3.0 中修复: https://github.com/swagger-api/swagger-ui/issues/2700

您需要更新 Swagger UI 版本。

【讨论】:

  • 我使用 django rest swagger,我该怎么办?
  • @SaeedBabashahi 试试最新版本的 django-rest-swagger (2.2.0)。它包括 Swagger UI 3.x。
  • 谢谢,我查了一下,但它有一个 JWT 授权的错误。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2015-05-01
  • 1970-01-01
  • 2016-05-01
  • 2019-01-29
  • 2018-07-16
相关资源
最近更新 更多