Redoc 侧边菜单 - 编程之家

如何解决Redoc 侧边菜单

我想在我的 API 文档中使用 Redoc。我也有招摇。

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

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

我的redoc设置：

app.UseReDoc(c =>
            {
                c.DocumentTitle = $"Documentation";
                c.SpecUrl = /api/docs/swagger.json";
                c.RoutePrefix = "docs";
            });

解决方法

该文档指的是 info.description 字段。

您可以将自述文件嵌入到 API 定义中，如下所示：

info:
  description:
     $ref: ./path/to/readme.md

将该路径替换为自述文件的实际路径。

来源：https://redoc.ly/docs/api-reference-docs/embedded-markdown/#embedded-markdown-in-redocly-api-reference-docs

注意：如果您无法更改 API 描述，您可以在后期处理中使用 OpenAPI CLI 和带有 bundle 命令的自定义装饰器进行更改。