asp.net-core-3.1 - 重做侧边菜单

Question

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

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

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

我的重做设置：

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

Answer 1

该文档指的是该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命令的自定义装饰器在后处理中进行。