问题标签 [redoc]

我在我的 WebApi 项目中安装了带有 NSwag 包的 Redoc。但我发现输出 API 文档中有很多功能不起作用：

1. 摘要和备注标签没有换行符

2. Example 的标签，代码未在文档中显示

如果我遵循Microsoft 的标签建议，不确定它是否应该工作？

因为我发现除了“Param”、“Returns”之外，没有一个标签可以作为Redoc 样本正常工作

更新：

我尝试设置这样的备注：

但它变成了：

根据redoc github 页面，有一个Rebilly API的实际使用示例。我真的很喜欢它的格式，也想用作我的格式。我已经使用 redoc 创建了开放的 api yaml 文件，但是开箱即用的格式并不吸引人。

有谁知道我们如何获得与Rebilly API相同的格式？

[重做版本：1.0]

我希望类型的属性string[]也成为 Redoc 中的鉴别器属性。但是，这似乎是不可能的，它必须是字符串类型。有没有办法绕过这个限制？

如果这不可能，我正在探索一种解决方法，我创建一个临时字符串属性作为鉴别器，然后在 Redoc 初始化结束时执行一些 JavaScript 以从 Payload 部分隐藏该属性。但是，我无法找到可以添加此类 JavaScript 代码的正确事件。事件Redoc.init太早了，html 还没有渲染。

• 我怎样才能利用正确的事件来修改 DOM 并从 Payload 中隐藏这个临时字符串属性？

• 有没有第三种选择，我可以让一个属性是一个字符串数组，也可以作为一个鉴别器？

我已经使用 redoc 以及所有格式完成了文档的创建。现在我想在 github 页面上发布它。

有一种方法可以使用以下命令生成静态 html 页面 -

但是这种方法的一个问题是 - 它不保留格式。

有什么方法可以在 gh-pages 上发布所有格式的文档

目前 Redoc 仅支持左侧面板上的 2 种深度菜单。有什么办法，我们可以再增加一个深度吗？有人已经为此创建了问题 - https://github.com/Redocly/redoc/issues/1489

我在OpenAPI Reference中没有看到任何与此相关的具体内容，所以我想在这里请求确认。

假设我有以下数据的参考：

是否可以引用此组件但仅从内部获取特定属性，例如uidand username，并排除其余部分？例如

$ref: '#/components/schemas/Foobar(uid,username)'

我的用例是我有一个库调用，它从数据库中返回记录，根据用户输入根据需要添加（或删除）其他记录。所以我们可以myCall(['username']);只返回用户名，并myCall(['username', 'location']);返回用户名和位置。

如果我想在我的 API 中正确记录它的各种用法，我目前必须手动维护输出的所有不同变体。

我希望我可以制作一些我可以引用的“灵活”组件，并让它在 OpenAPI 规范中仍然有效。

我能找到的最接近的是将所有属性包装在anyOf：

...但是如果用 ReDoc 之类的东西解析，它只会显示输出将是任何列出的属性，而我实际上需要能够声明“在任何这些属性中，将输出以下内容”。

我猜我的用例有点深奥，但我希望被证明是错误的:)

使用 DRF 的内置 API 记录方式，我能够编写如下所示的文档字符串，并且每个操作都由其对应的行记录：

我正在切换到 library drf-spectacular，它允许轻松生成符合 OpenAPI 的方案。但是，现在为每个操作呈现相同的文档字符串，这使得我的文档非常冗长且多余。

有没有办法只为每个操作呈现文档字符串的相关部分？

redoc 指南指定在代码示例中使用原始文本作为源： https ://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-codeSamples ，如下所示：

但是我想让我的 OpenApi3.0 YAML 成为一个动态文档，因此更愿意直接从测试文件中导入代码，例如：

其中的内容js_api_test.js只是：

这样，只要测试通过，就可以保证导入的代码正常工作 - 保持文档有效。

鉴于我已经依赖于从 YAML 文件中生成大量样板文件，因此保持文件的所有方面都有效似乎是理想的。

提前致谢！