问题标签 [redoc]

我正在从 Django 1.11 --> 3.1.5 做一些迁移工作

以前使用“rest_framework_swagger”，我可以在 url.py 中完成 swagger api 分组

并得到这个（注意它分组 v9）

但是，我在 Django 3.1.5 url.py 上尝试过使用“drf_yasg”

我的 api 定义（请注意我使用的是@api_view）

但是，我明白了（注意到 v2 没有分组）。而且当我进行测试时，也有错误。（代码 404 错误：未找到）

如何将这些分组到 drf_yasg 中的 API 并确保没有错误？注意如果 url.py 是这样的，没有错误但它不分组

我有一个使用 FastAPI 的 REST API 构建，各种查询字符串参数都可以正常工作，生成工作openapi.json输出：

生成：

但是我有一些使用枚举值的参数。生成的 openAPI 定义缺少type说明符 -

生成：

如您所见schema.type，缺少，这会导致其他读取openapi.json文件的工具中断。

如何为 Enum 参数生成openapi.json带type键？

我直接在 RStudio 中使用 redoc 输出并单击“knit”，从 rmarkdown 文件创建了一个 word 文件。这工作正常。

但试图将其转换回 Rmd 会引发错误。其他人有过吗？

我想将 Redoc 用于我的 API 文档。我也有招摇。

我在这里找到：https ://github.com/Redocly/redoc这一行 -将 API 介绍集成到侧边菜单 - ReDoc 利用 OpenAPI 描述字段中的降价标题。它将它们拉入侧面菜单，还支持深度链接。

我想将我的自述文件添加到 Redoc 的左侧栏中。但是我没有找到任何好的例子。我应该改变什么，应该在哪里添加自述文件？

我的重做设置：

在我的 openapi yaml 文件中，我有一个Layout模式，它有一个属性fields，它是一个Field对象的数组。我的想法是拥有一个具有公共属性的父字段架构，以及一些继承这些并扩展其特定属性的子架构（ TextInput、Select、Toggle等）。

所以，这就是我正在尝试的：

编译工作正常，但是当我展开fields属性时，我看到：

我希望petType200 响应中的属性会发生类似的情况： http ://redocly.github.io/redoc/#operation/findPetsByStatus

我有一个招摇的 JSON，其中标签没有任何特定的顺序。我正在尝试在 Redoc UI 中呈现这个 json。有没有办法使用按字母顺序排序的标签来呈现 Redoc Ui。

注意：在具有以下属性的 swagger UI 中也是如此

我正在寻找类似的东西。

我正在尝试构建一个简单的 Swagger 模型：

由于某种原因，生成的 HTML 不显示player_id'example字段。这让我觉得我做的不对。s

所以问题是如果使用模型作为类型实际上可以像我试图做的那样完成。example如果字段的父级是parameters:而不是properties:.

更新：我阅读了https://swagger.io/docs/specification/adding-examples/Object and Property Examples上的部分，看来我的代码片段应该有效。

更新#2：我实际上下载redoc-cli了（这是 OpenAPI 的 CLI 工具 -> html 包）并从 Swagger Editor 中获取了一个示例规范，该规范example下的字段properties模仿了我的问题，看起来像是预期的（见我附上的屏幕截图）：

我正在尝试构建一个简单的 Swagger 模型：

由于某种原因，生成的 HTML 不会在查询参数下呈现状态过滤器。这让我觉得我没有正确地做到这一点。

也就是说，当我将架构编辑为：

过滤器被渲染。

一些上下文：对于我正在使用的 spec.yaml -> html redoc-cli（这是 OpenAPI 的 CLI 工具 -> html 包）。

问题是是否可以渲染 #1 或者 OpenAPI 格式不支持它？

我确实阅读了https://swagger.io/docs/specification/adding-examples/Object and Property Examples上的部分，但没有找到很多与过滤器相关的信息。

按照最佳实践，OpenAPI 规范应仅包含接口使用信息，而不包含技术/开发人员相关信息。

尽管如此，我觉得这是一个记录重要技术细节的好地方——例如实现接口的源代码文件名、计划新功能的 Jira ID 等。

考虑externalDocs是否在 ReDoc 中正确呈现字段或某种有条件的 ReDoc 生成以生成一个公共和另一个包含额外技术细节的内部 API 规范。

使用 drf-yasg 时如何更改 redoc-ui 中自动出现的请求的名称。

例如：在图像中，您可以看到请求名为 fid_data-entities_update，它是从 URL 中提取的。

如何覆盖/重命名它？