Redoc侧菜单

Question

我想使用Redoc作为我的API文档。我也很自负。

我在这里发现：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";
            });

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命令的自定义装饰器在后处理中完成该操作。